build: add create release proposal action

[RafaelGSS]

Blocked until the following PR lands

• feat: add --yes option to git node release node-core-utils#862
• feat: add --releaseDate to git node release node-core-utils#863
• update: fix default answers in release --prepare node-core-utils#864

Refs: nodejs/security-wg#860

---

The purpose is to have an action that will generate the release proposal (assuming the vN.x-staging is up to date). After that, I'll create a second action the keep the staging branches up-to-date.

cc: @nodejs/releasers

[nodejs-github-bot]

Review requested:

• @nodejs/actions

[aduh95]

We probably should not expect to have push permission, and instead make an API call to create the release commit using a createCommitOnBranch API call

[RafaelGSS]

Actually, the gh pr create also pushes the branch so it should just works? cli/cli#6958

[aduh95]

What I'm saying is: the workflow should not have push permissions, this git push call is problematic

[RafaelGSS]

Why? Wouldn't it fall in the same circumstances as commit-queue.yml?

[aduh95]

I think we don't need that permission, so for that reason, we should not use it, it's good practice to use the smallest set of permissions as possible.

[RafaelGSS]

What's your suggestion then? Sorry, I don't get it yet

[aduh95]

My suggestion is to use an createCommitOnBranch API call. I'll try building an alternate proposal using it.

[RafaelGSS]

What do you think about a follow-up PR? I mean, the end goal is to create a proposal using automation, the sooner we land that the sooner we can test it and see how it behaves in practice.

I wish I could use it for next v23 release.

[RafaelGSS]

Uh, just found the action is broken. I will fix it https://github.com/nodejs/node/actions/runs/11804669470

[RafaelGSS]

I've been using a fork to test this action and I got some errors related to the changelog token (https://github.com/RafaelGSS/node/actions/runs/11901774519/job/33165408792)

However, the action seems to work fine when using a correct token (on my local):

➜  node (v23.x-staging) ./tools/actions/create-release.sh 2024-11-20 23
+ RELEASE_DATE=2024-11-20
+ RELEASE_LINE=23
+ '[' -z 2024-11-20 ']'
+ '[' -z 23 ']'
+ git config --local user.email [email protected]
+ git config --local user.name 'Node.js GitHub Bot'
+ git node release --prepare --skipBranchDiff --yes --releaseDate 2024-11-20
   ✔  No git cherry-pick in progress
   ✔  No git am in progress
   ✔  No git rebase in progress
--------------------------------------------------------------------------------
⠋ Bringing upstream/v23.x-staging up to date...From github.com:nodejs/node
 * branch                  v23.x-staging -> FETCH_HEAD
✔  upstream/v23.x-staging is now up-to-date
v23.x-staging is out of sync with upstream/v23.x-staging. Mismatched commits:
 - 94b329eb9b build: add create release proposal action
 - def0419a13 fixup! build: add create release proposal action
 - d77dfa0868 fixup! fixup! build: add create release proposal action
 - 31718928b1 fixup! fixup! fixup! build: add create release proposal action
 - df3289b4f7 fixup! fixup! fixup! fixup! build: add create release proposal action
 - b406328711 fixup! fixup! fixup! fixup! fixup! build: add create release proposal action
 - fee2f6d86a fixup! fixup! fixup! fixup! fixup! fixup! build: add create release proposal action
 - 4800a3f098 fixup! fixup! fixup! fixup! fixup! fixup! fixup! build: add create release proposal action
 - 5d33422dff fixup! fixup! fixup! fixup! fixup! fixup! fixup! fixup! build: add create release proposal action
--------------------------------------------------------------------------------
HEAD is now at 693fda0802 lib: remove unused file `fetch_module`
   ✔  Reset to upstream/v23.x-staging
✔  Latest release on 23.x line is 23.2.0
--------------------------------------------------------------------------------
⠙ Creating new proposal branch for 23.3.0Switched to a new branch 'v23.3.0-proposal'
✔  Created new proposal branch for 23.3.0
✔  Updated 'src/node_version.h' for 23.3.0
✔  Updated REPLACEME items in docs
--------------------------------------------------------------------------------
✔  Updated CHANGELOG.md
⠹ Updating CHANGELOG_V23.mdFrom github.com:nodejs/node
 * branch                  v23.x      -> FETCH_HEAD
✔  Updated CHANGELOG_V23.md
--------------------------------------------------------------------------------
From github.com:nodejs/node
 * branch                  v23.x      -> FETCH_HEAD
2024-11-20, Version 23.3.0 (Current)

Notable changes:

doc:
  * enforce strict policy to semver-major releases (Rafael Gonzaga) https://github.com/nodejs/node/pull/55732
src:
  * (SEMVER-MINOR) add cli option to preserve env vars on dr (Rafael Gonzaga) https://github.com/nodejs/node/pull/55697
util:
  * (SEMVER-MINOR) add sourcemap support to getCallSites (Marco Ippolito) https://github.com/nodejs/node/pull/55589
  * (SEMVER-MINOR) fix util.getCallSites plurality (Chengzhong Wu) https://github.com/nodejs/node/pull/55626

PR-URL: TODO
--------------------------------------------------------------------------------
--------------------------------------------------------------------------------
   ✔  Release preparation for 23.3.0 complete.

   ℹ  To finish the release proposal, run:
      $ git push -u upstream v23.3.0-proposal
Finally, proceed to Jenkins and begin the following CI jobs:
      * https://ci.nodejs.org/job/node-test-pull-request/
      * https://ci.nodejs.org/job/citgm-smoker/
   ℹ  If this release has deps/v8 changes, you'll also need to run:
      * https://ci.nodejs.org/job/node-test-commit-v8-linux/
+ git config push.default current
++ awk '/^## 2024-11-20/ { print substr($0, 4) }' doc/changelogs/CHANGELOG_V23.md
+ TITLE='2024-11-20, Version 23.3.0 (Current), @RafaelGSS'
++ mktemp
+ TEMP_BODY=/tmp/tmp.aE5l3vXtyn
+ awk '/## 2024-11-20/,/^<a id=/{ if (!/^<a id=/) print }' doc/changelogs/CHANGELOG_V23.md
++ git branch --show-current
+ gh pr create --title '2024-11-20, Version 23.3.0 (Current), @RafaelGSS' --body-file /tmp/tmp.aE5l3vXtyn --head v23.3.0-proposal

Creating pull request for v23.3.0-proposal into main in nodejs/node

pull request create failed: GraphQL: Head sha can't be blank, Base sha can't be blank, No commits between main and v23.3.0-proposal, Head ref must be a branch (createPullRequest)

If you note there's an error in the end:

pull request create failed: GraphQL: Head sha can't be blank, Base sha can't be blank, No commits between main and v23.3.0-proposal, Head ref must be a branch (createPullRequest)

That happens because the v23.0.0-proposal branch wasn't pushed to upstream before the gh pr create. I have tried to use a different approach (--head) - it seems related to cli/cli#2691.

We should push the v23.3.0-proposal to upstream before gh pr create and it should work.

Result: #55921

[RafaelGSS]

To summarize:

• Store changelog-maker token
• Push proposal branch before gh pr create

[targos]

So, IIUC with this approach we would run the automation to create the initial draft and then checkout the PR locally to work on the changelog / notable changes ?

[RafaelGSS]

So, IIUC with this approach we would run the automation to create the initial draft and then checkout the PR locally to work on the changelog / notable changes ?

Not necessarily. This automation will generate the changelog and notable changes automatically (e.g #55921). However, if some notable changes requires a detailed text and then yes, we would need to checkout the PR and adjust the changelog. But, this can also be automated in the future since we have established a pattern of a notable-change label with a summary in the PR description.

[RafaelGSS]

@rvagg Do you think it's reasonable to make changelog-maker to read from .ncurc if no config.json is found? I could do

echo '{
  "user": "'$(ncu-config get username)'",
  "token": "'$(ncu-config get token)'"
}' > config.json

meanwhile

[nodejs-github-bot]

Landed in c75aaac