Skip to content

tools: validate commit list as part of lint-release-commit #56291

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
nodejs-github-bot merged 11 commits into from
Jan 9, 2025
Merged

tools: validate commit list as part of lint-release-commit #56291

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
75be282
tools: validate commit list as part of `lint-release-commit`
aduh95 Dec 17, 2024
e3b2220
fixup! tools: validate commit list as part of `lint-release-commit`
aduh95 Dec 17, 2024
60a0bce
Update .github/workflows/lint-release-proposal.yml
aduh95 Dec 17, 2024
5e54f8f
fixup! tools: validate commit list as part of `lint-release-commit`
aduh95 Dec 17, 2024
686d5cb
minor fixes and improvements
aduh95 Dec 18, 2024
d69f027
move JS to a separate file
aduh95 Dec 18, 2024
eae03e3
fix for revert commits
aduh95 Dec 18, 2024
e8bb005
add validation for dont-land labels
aduh95 Dec 19, 2024
6022db5
fixup! add validation for dont-land labels
aduh95 Dec 19, 2024
2ec8cbd
use a format of input somewhat compatible with `git log`
aduh95 Dec 19, 2024
ba114e9
add error message to help with debugging
aduh95 Dec 21, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
use a format of input somewhat compatible with git log
  • Loading branch information
@aduh95
aduh95 committed Dec 19, 2024
commit 2ec8cbd4602102f88d17fc3bd6af7c4f2bef5fc8
2 changes: 1 addition & 1 deletion .github/workflows/lint-release-proposal.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ jobs:
gh api \
-H "Accept: application/vnd.github+json" \
-H "X-GitHub-Api-Version: 2022-11-28" \
--jq '.commits.[] | { smallSha: .sha[0:10], splitTitle: .commit.message|split("\n\n")|first|split(":") } + (.commit.message|capture("\nPR-URL: (?<prURL>.+)\n"))' \
--jq '.commits.[] | { smallSha: .sha[0:10] } + (.commit.message|capture("^(?<title>.+)\n\n(.*\n)*PR-URL: (?<prURL>.+)\n"))' \
"/repos/${GITHUB_REPOSITORY}/compare/v${MAJOR}.x...$GITHUB_SHA" --paginate \
| node tools/actions/lint-release-proposal-commit-list.mjs "$CHANGELOG_PATH" "$GITHUB_SHA" \
| while IFS= read -r PR_URL; do
Expand Down
13 changes: 7 additions & 6 deletions tools/actions/lint-release-proposal-commit-list.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,10 @@
// Takes a stream of JSON objects as inputs, validates the CHANGELOG contains a
// line corresponding, then outputs the prURL value.
//
// $ ./lint-release-proposal-commit-list.mjs "path/to/CHANGELOG.md" "deadbeef00" <<'EOF'
// {"prURL":"https://github.com/nodejs/node/pull/56131","smallSha":"d48b5224c0","splitTitle":["doc"," fix module.md headings"]}
// {"prURL":"https://github.com/nodejs/node/pull/56123","smallSha":"f1c2d2f65e","splitTitle":["doc"," update blog release-post link"]}
// EOF
// Example:
// $ git log upstream/vXX.x...upstream/vX.X.X-proposal \
// --format='{"prURL":"%(trailers:key=PR-URL,valueonly,separator=)","title":"%s","smallSha":"%h"}' \
// | ./lint-release-proposal-commit-list.mjs "path/to/CHANGELOG.md" "$(git rev-parse upstream/vX.X.X-proposal)"

const [,, CHANGELOG_PATH, RELEASE_COMMIT_SHA] = process.argv;

Expand All @@ -28,7 +28,7 @@ const commitList = changelog.slice(commitListingStart, commitListingEnd === -1 ?

let expectedNumberOfCommitsLeft = commitList.match(/\n\* \[/g).length;
for await (const line of stdinLineByLine) {
const { smallSha, splitTitle, prURL } = JSON.parse(line);
const { smallSha, title, prURL } = JSON.parse(line);

if (smallSha === RELEASE_COMMIT_SHA.slice(0, 10)) {
assert.strictEqual(
Expand All @@ -42,7 +42,8 @@ for await (const line of stdinLineByLine) {
assert.notStrictEqual(lineStart, -1, `Cannot find ${smallSha} on the list`);
const lineEnd = commitList.indexOf('\n', lineStart + 1);

const expectedCommitTitle = `${`**${splitTitle.shift()}`.replace('**Revert "', '_**Revert**_ "**')}**:${splitTitle.join(':')}`;
const colonIndex = title.indexOf(':');
const expectedCommitTitle = `${`**${title.slice(0, colonIndex)}`.replace('**Revert "', '_**Revert**_ "**')}**${title.slice(colonIndex)}`;
try {
assert(commitList.lastIndexOf(`/${smallSha})] - ${expectedCommitTitle} (`, lineEnd) > lineStart, `Commit title doesn't match`);
} catch (e) {
Expand Down