Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

Move vendored assets to Git Submodules and `.gitignore` built assets

Đang mở
  • Có gì không ổn?
#2,052 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 1 ngày

Chưa có ai nhận issue này.

Đánh giá

Độ khó
4/5
Thời gian dự kiến
3-5 ngày
Mức phù hợp với người mới
48/100
Loại issue
Tái cấu trúc
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Ít trao đổi
Công nghệ
git, github, nodejs, shell
Lĩnh vực
build-system, documentation

Hướng nghiên cứu

Bắt đầu bằng cách đọc update-blog.sh, update-readmes.sh và update-lb4-docs.js, sau đó kiểm tra npm run build gọi chúng như thế nào và CI xử lý các asset được tạo ra như thế nào. Xác định vị trí của các submodule và các đường dẫn build cần được bỏ qua. Công việc được xem là hoàn tất khi các mã nguồn được vendor hóa có nguồn gốc Git rõ ràng, các build không còn ghi đè lên các bản sao được tạo đã được theo dõi và site build hiện có vẫn hoạt động.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

ci developer-experience

The website has scripts which pulls data from GitHub and NPM:

  • update-blog.sh
    Clones loopbackio/loopback-blog into /blog
  • update-readmes.sh
    Downloads READMEs from GitHub "raw" or NPM Registry into /doc/en/[lb3|lb4|community]/readmes
  • update-lb4-docs.js
    Copies pre-generated markdown API Docs from @loopback/docs into /doc/en/lb4

They pose some issues:

  • Accidental manual editing: Contributors may accidentally contribute changes to these assets, only to be overridden by the CI pipeline.
  • Rate-limitng: Contributors running npm run build -> update-readmes.sh may inadvertently update the local copies with GitHub "rate limit reached" error pages.
  • Unclear provenance: As the .git directory is not preserved, the provenance of where and when exactly the assets were vendored is no clear.
  • Updates are reactive: The assets are only re-vendored when a PR is merged.

Git Submodules solve this problem. Updates would be handled by Renovate instead, which would open PRs.

Ngôn ngữ chính
HTML
Star
276
Fork
382
Merge trung bình
6 giờ 54 phút
Pull request đã merge (30 ngày)
22

Chuẩn bị môi trường

  • Không có Dockerfile hay tệp Docker Compose
  • Không có mẫu pull request
  • Đọc hướng dẫn đóng góp

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của loopbackio/loopback.io

Tất cả issue của loopbackio/loopback.io

Issue tương tự

Thêm issue về Build System

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.