nodejs / nodejs/node-core-utils
pr_checker: ignore superseded GitHub Actions check suites when a head SHA is reused
まだ誰も着手していません。
- 主要言語
- JavaScript
- スター
- 313
- フォーク
- 137
- 平均マージ
- 2日 8時間
- マージ済み PR(30日)
- 24
説明
PRChecker.checkGitHubCI() can incorrectly report a PR as having failed GitHub CI when its current head commit has both:
- an older cancelled/failed GitHub Actions run; and
- a newer successful run of the same workflow.
This can happen when a PR branch is force-pushed away from a commit and later force-pushed back to exactly the same SHA. GitHub
keeps both sets of check suites attached to that commit.
This occurred on nodejs/node#64803, https://github.com/nodejs/node/pull/64601 whose current head SHA is:
ee1ca501264411a3e993d4ed487f833fb0ffa841
a23d7a9a84a190e3804f9b2fb200feb833f3114a
Timeline:
- An Actions run was started for this SHA:
https://github.com/nodejs/node/actions/runs/30359390795 - The PR branch was updated, causing that run to be cancelled by the workflow's
cancel-in-progressconfiguration. - The branch was subsequently force-pushed back to the same SHA:
https://github.com/nodejs/node/pull/64803#event-28598521231 - A new run for the same SHA completed successfully:
https://github.com/nodejs/node/actions/runs/30360481950 - The latest Jenkins CI also completed successfully:
https://ci.nodejs.org/job/node-test-pull-request/75495/
However, the commit queue reported one failed and 15 cancelled GitHub Actions jobs from the older, superseded runs:
https://github.com/nodejs/node/pull/64803#issuecomment-5226872042
The commit checks page contains both the old cancelled suites and the newer successful suites:
https://github.com/nodejs/node/commit/ee1ca501264411a3e993d4ed487f833fb0ffa841/checks
The reported macOS failure was also produced while the old workflow was being cancelled, rather than by a test failure:
https://github.com/nodejs/node/actions/runs/30359390795/job/90275679554
The GraphQL query retrieves up to 100 check suites associated with the current commit:
https://github.com/nodejs/node-core-utils/blob/v7.0.1/lib/queries/PRCommits.gql#L28-L44
checkGitHubCI() then iterates over every GitHub Actions suite and treats any non-successful historical suite as a current
failure:
https://github.com/nodejs/node-core-utils/blob/v7.0.1/lib/pr_checker.js#L461-L515
It does not identify whether an older suite has been superseded by a newer run of the same workflow.
As a result, an obsolete cancelled or failed run can permanently prevent the commit queue from accepting that SHA, even though
all current CI runs succeeded.
For each GitHub Actions workflow, only the latest applicable run for the current head SHA should determine the CI result. Older
runs superseded by a newer run of the same workflow should be ignored.
Refs: https://github.com/nodejs/node/pull/64601#issuecomment-5226071594
Refs: https://github.com/nodejs/node/pull/64803#issuecomment-5226872042
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
lib/pr_checker.js から始めます: checkGitHubCI() は lib/queries/PRCommits.gql が返すスイートを反復処理します。リンクされた nodejs/node の例を使って、1 つの head SHA に対する重複した実行を理解し、その後、各 workflow について最新の該当する実行だけが結果に影響し、以前の置き換えられた実行が受け入れを妨げないことを確認します。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- github-actions, javascript
- 領域
- ci-cd, tooling
- issue の種類
- バグ
- 難易度
- 3/5
- 見積もり時間
- 1〜2日
- 活発さ
- 静か
- 明瞭さ
- おおむね明確
- 初心者へのやさしさ
- 68/100