Skip to content

chore: add automation for release keys - #2603

Open
nschonni wants to merge 2 commits into
nodejs:mainfrom
nschonni:release-keys-ci
Open

chore: add automation for release keys#2603
nschonni wants to merge 2 commits into
nodejs:mainfrom
nschonni:release-keys-ci

Conversation

@nschonni

@nschonni nschonni commented Aug 8, 2026

Copy link
Copy Markdown
Member

Description

Either a test job in CI could run if someone touches the keys file, or a periodic sync can just check for changes and create a PR. I opted for the later, but the former would work as well.

Motivation and Context

#2569
I assume that a daily poll is more than frequent enough, although it's possible that a new Releaser could open the PR manually here while the other upstream PRs are waiting. Any sort issues would eventually get corrected by the PR this action would create.

Potentially the upstream documentation to open the PR here for the keys could be removed if this lands.

Testing Details

Example Output(if appropriate)

Types of changes

  • Documentation
  • Version change (Update, remove or add more Node.js versions)
  • Variant change (Update, remove or add more variants, or versions of variants)
  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Other (none of the above)

Checklist

  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING.md document.
  • All new and existing tests passed.

Comment thread .github/workflows/automatic-release-keys.yml Outdated
Comment thread .github/workflows/automatic-release-keys.yml
@MikeMcC399

Copy link
Copy Markdown
Contributor

I'm not sure if it should be part of the documented advice, but I would recommend disabling the workflow Automatically update Docker image versions before merging a PR with only key changes. That prevents immediate PR creation for a new Docker version release, and delays updating Dockerfile instances until there is an actual release using the changed key list.

@MikeMcC399 MikeMcC399 added the keys Related to keys used to sign releases label Aug 8, 2026
@nschonni

nschonni commented Aug 8, 2026

Copy link
Copy Markdown
Member Author

@MikeMcC399 I changed the cron frequency to weekly, and added a body parameter for the PR creation.
edit: First force push was missing the body, but fixed now

Comment thread .github/workflows/automatic-release-keys.yml Outdated

@MikeMcC399 MikeMcC399 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@MikeMcC399

Copy link
Copy Markdown
Contributor

Running this workflow will fix the keys order difference described in #2569.

@nschonni

Copy link
Copy Markdown
Member Author

@nodejs/releasers would it make sense to include your group as "reviewers" in the generated PRs for visibility, or would that just be noise?

@aduh95

aduh95 commented Aug 10, 2026

Copy link
Copy Markdown
Contributor

I'm not sure a cron is the correct way forward, a linter would be much better, avoiding "invalid" data to be merged in rather than correcting it after-the-fact

@nschonni

Copy link
Copy Markdown
Member Author

@aduh95 I added a second plain CI/check action too. I can keep both, or drop the cron one if you think the releasers prefer to open the PRs here manually

@aduh95

aduh95 commented Aug 11, 2026

Copy link
Copy Markdown
Contributor

I'm not sure, an automated process makes it easier for a "bad" change to make its way here (i.e. someone getting write access to release-keys to affect docker-node); it really depends on thorough the review process actually is for this kind of automated PRs

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

keys Related to keys used to sign releases

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Key order in keys/node.keys does not match node/README.md sort order by first name

3 participants