Extract the fat inline bash steps from upstream-release-docs.yml into scripts/
メンテナーはふだん 1 日以内に返信
まだ誰も着手していません。
評価
- 難易度
- 4/5
- 見積もり時間
- 3〜5日
- 初心者へのやさしさ
- 52/100
- issue の種類
- リファクタリング
- 明瞭さ
- 明確に書かれている
- 活発さ
- 活発
- 技術スタック
- bash, github-actions, javascript
調査の方向性
.github/workflows/upstream-release-docs.yml、Augment PR body ステップ、および scripts/upstream-release/ にある既存のファイルを読みます。実際の過去の実行で使われた環境を使用して、抽出したスクリプトの出力をその実行の実際の PR body と比較します。完了の条件は、動作が維持され、スクリプトが既存の formatting と linting の設定でカバーされていることです。
索引モデルが issue の本文から書いたものです。
説明
.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[].runfrom the YAML, stubbing${{ }}, and piping it to shellcheck. scripts/upstream-release/already holds five.mjsfiles 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 bodytoscripts/upstream-release/render-pr-body.mjsAssign reviewersandResolve release owner and contributorsas 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-docsskill. Capture skill signal files, mostly file reads andGITHUB_OUTPUTheredocs.- 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.
- 主要言語
- JavaScript
- スター
- 4
- フォーク
- 4
- 平均マージ
- 23時間 10分
- マージ済み PR(30日)
- 71
環境構築
このプロジェクトの開発コンテナを、あなたの GitHub アカウントでブラウザ上に起動します。
- Dockerfile・Docker Compose ファイルなし
- プルリクエストのテンプレートあり
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
stacklok/docs-website のほかの issue
-
documentation enhancement needs-triage
難易度 2/5 1〜3時間 初心者へのやさしさ 82/100
stacklok/docs-website#1258 ·
メンテナーはふだん 1 日以内に返信
-
documentation enhancement needs-triage
難易度 1/5 1時間未満 初心者へのやさしさ 85/100
stacklok/docs-website#1241 ·
メンテナーはふだん 1 日以内に返信
-
bug documentation needs-triage
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
stacklok/docs-website#1149 · コメント 2 件 ·
メンテナーはふだん 1 日以内に返信
-
needs-triage
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
stacklok/docs-website#1143 ·
メンテナーはふだん 1 日以内に返信
-
needs-triage
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
stacklok/docs-website#564 · コメント 1 件 ·
メンテナーはふだん 1 日以内に返信
stacklok/docs-website の issue をすべて見る
似ている issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 77/100
mihai-vlc/sublime-jsfmt#56 ·
-
Bug v3
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 77/100
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 76/100
biomejs/biome#12475 · コメント 1 件 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 84/100
メンテナーはふだん 1 日以内に返信