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

Extract the fat inline bash steps from upstream-release-docs.yml into scripts/

Đang mở
  • Có gì không ổn?
#1,112 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
52/100
Loại issue
Tái cấu trúc
Độ rõ ràng
Đặc tả rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
bash, github-actions, javascript
Lĩnh vực
ci-cd, devops, tooling

Hướng nghiên cứu

Đọc .github/workflows/upstream-release-docs.yml, bước Augment PR body và các tệp hiện có trong scripts/upstream-release/. Sử dụng môi trường từ một lần chạy thực tế trước đây để so sánh đầu ra của script đã trích xuất với PR body thực tế của lần chạy đó; hoàn thành có nghĩa là hành vi được giữ nguyên và script được bao phủ bởi thiết lập formatting và linting hiện có.

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

Mô tả

enhancement github_actions needs-triage

.github/workflows/upstream-release-docs.yml is 1667 lines across 41 steps, including 960 lines of inline bash. The size is concentrated in four steps:

Step Inline bash lines
Augment PR body (marker-delimited section) 313
Assign reviewers and prepare contributor mentions 121
Resolve release owner and contributors 99
Capture skill signal files 74
remaining 37 steps 353 (avg 9)

Two reasons to extract the big ones:

  • Nothing lints the inline bash. There is no shellcheck or actionlint in CI, so checking a change today means hand-extracting steps[].run from the YAML, stubbing ${{ }}, and piping it to shellcheck.
  • scripts/upstream-release/ already holds five .mjs files and this workflow already invokes one, so a script there inherits Prettier and ESLint from existing CI with no new tooling.

Augment PR body is the best first candidate: its only I/O is roughly 25 env vars in and one gh pr edit --body-file out, and the PR body is the artifact reviewers actually read.

Scope

In:

  • Augment PR body to scripts/upstream-release/render-pr-body.mjs
  • Assign reviewers and Resolve release owner and contributors as separate follow-ups if the first goes cleanly

Out:

  • The two Claude step prompts (88 lines). Their content is almost entirely interpolated run context, and the durable instructions already live in the upstream-release-docs skill.
  • Capture skill signal files, mostly file reads and GITHUB_OUTPUT heredocs.
  • The 37 short steps, which belong inline.

Sequencing

After #1111 has run live on two or three release PRs. That change is unvalidated, and stacking a refactor on it means a live failure has two candidate causes instead of one.

#1111 and this refactor touch the same steps, so if #1111 needs iteration, extract Augment PR body first (#1111 only added two table rows and two sections to it) and leave the reviewer steps until after validation.

Verification

Behavior-preserving: render the extracted script against the env of a real past run and diff the output against that run's actual PR body.

Ngôn ngữ chính
TypeScript
Star
4
Fork
3
Merge trung bình
22 giờ
Pull request đã merge (30 ngày)
37

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

Mở trong Codespaces

Khởi chạy dev container của dự án ngay trên trình duyệt, bằng tài khoản GitHub của bạn.

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 stacklok/docs-website

Tất cả issue của stacklok/docs-website

Issue tương tự

Thêm issue về TypeScript

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.