Skip to content
Merged
57 changes: 46 additions & 11 deletions .github/workflows/lint-release-proposal.yml
Original file line number Diff line number Diff line change
Expand Up @@ -33,30 +33,65 @@ jobs:
echo "COMMIT_SUBJECT=$COMMIT_SUBJECT" >> "$GITHUB_ENV"
- name: Lint release commit message trailers
run: |
EXPECTED_TRAILER="^PR-URL: $GITHUB_SERVER_URL/$GITHUB_REPOSITORY/pull/[[:digit:]]+\$"
EXPECTED_TRAILER="^$GITHUB_SERVER_URL/$GITHUB_REPOSITORY/pull/[[:digit:]]+\$"
echo "Expected trailer format: $EXPECTED_TRAILER"
ACTUAL="$(git --no-pager log -1 --format=%b | git interpret-trailers --parse --no-divider)"
PR_URL=$(git --no-pager log -1 --format='%(trailers:key=PR-URL,valueonly)')
echo "Actual: $ACTUAL"
echo "$ACTUAL" | grep -E -q "$EXPECTED_TRAILER"
echo "$PR_URL" | grep -E -q "$EXPECTED_TRAILER"

PR_URL="${ACTUAL:8}"
PR_HEAD="$(gh pr view "$PR_URL" --json headRefOid -q .headRefOid)"
echo "Head of $PR_URL: $PR_HEAD"
echo "Current commit: $GITHUB_SHA"
[ "$PR_HEAD" = "$GITHUB_SHA" ]
env:
GH_TOKEN: ${{ github.token }}
- name: Verify it's release-ready
run: |
SKIP_XZ=1 make release-only
- name: Validate CHANGELOG
id: releaser-info
run: |
EXPECTED_CHANGELOG_TITLE_INTRO="## $COMMIT_SUBJECT, @"
echo "Expected CHANGELOG section title: $EXPECTED_CHANGELOG_TITLE_INTRO"
CHANGELOG_TITLE="$(grep "$EXPECTED_CHANGELOG_TITLE_INTRO" "doc/changelogs/CHANGELOG_V${COMMIT_SUBJECT:20:2}.md")"
MAJOR=$(awk '/^#define NODE_MAJOR_VERSION / { print $3 }' src/node_version.h)
CHANGELOG_PATH="doc/changelogs/CHANGELOG_V${MAJOR}.md"
CHANGELOG_TITLE="$(grep "$EXPECTED_CHANGELOG_TITLE_INTRO" "$CHANGELOG_PATH")"
echo "Actual: $CHANGELOG_TITLE"
[ "${CHANGELOG_TITLE%%@*}@" = "$EXPECTED_CHANGELOG_TITLE_INTRO" ]
- name: Verify NODE_VERSION_IS_RELEASE bit is correctly set
run: |
grep -q '^#define NODE_VERSION_IS_RELEASE 1$' src/node_version.h
- name: Check for placeholders in documentation
run: |
! grep "REPLACEME" doc/api/*.md
gh api \
-H "Accept: application/vnd.github+json" \
-H "X-GitHub-Api-Version: 2022-11-28" \
--jq '.commits | map({ smallSha: .sha[0:10], splitTitle: .commit.message|split("\n\n")|first|split(":") })' \
"/repos/${GITHUB_REPOSITORY}/compare/v${MAJOR}.x...$GITHUB_SHA" --paginate |\
jq -r '.[] | "* [[`" + .smallSha + "`](" + env.GITHUB_SERVER_URL + "/" + env.GITHUB_REPOSITORY + "/commit/" + .smallSha + ")] - **" + (.splitTitle|first) + "**:" + (.splitTitle[1:]|join(":"))' |\
node --input-type=module -e '
import assert from "node:assert";
import {readFile} from "node:fs/promises";
import {createInterface} from "node:readline";
const stdinLineByLine = createInterface(process.stdin)[Symbol.asyncIterator]();
const [,CHANGELOG_PATH, GITHUB_SHA] = process.argv;
const changelog = await readFile(CHANGELOG_PATH, "utf-8");
const startCommitListing = changelog.indexOf("\n### Commits\n");
const commitList = changelog.slice(startCommitListing, changelog.indexOf("\n\n<a", startCommitListing))
// Checking for semverness is too expansive, it is left as a exercice for human reviewers.
.replaceAll("**(SEMVER-MINOR)** ", "")
// Correct Markdown escaping is validated by the linter, getting rid of it here helps.
.replaceAll("\\", "");

let expectedNumberOfCommitsLeft = commitList.match(/\n\* \[/g).length;
for await (const line of stdinLineByLine) {
if (line.includes(GITHUB_SHA.slice(0, 10))) {
assert.strictEqual(
expectedNumberOfCommitsLeft, 0,
"Some commits are listed without being included in the proposal, or are listed more than once",
);
continue;
}

assert(commitList.includes("\n"+line), `Missing "${line}" in commit list`);
expectedNumberOfCommitsLeft--;
}
assert.strictEqual(expectedNumberOfCommitsLeft, 0, "Release commit is not the last commit in the proposal");
Comment thread
aduh95 marked this conversation as resolved.
Outdated
' "$CHANGELOG_PATH" "$GITHUB_SHA"
env:
GH_TOKEN: ${{ github.token }}