Repository navigation
Automated releases #1114
Description
Motivation
Our current release process is for a core maintainer to run npx nx release --yes in main branch (requires npm login and GITHUB_TOKEN in .env).
We've previously spent quite a lot of effort in releasing via GitHub Actions, but never quite got it working reliably. A partially broken release is complex to recover from, so running a command locally proved to be more practical.
But our current release process relies too much on one person, and doesn't allow us to secure npm publishing via provenance or trusted publishing.
Acceptance criteria
- run
nx releaseon push tomainbranch- release is skipped if no user-facing commits (
feat,fix,perf) were pushed
- release is skipped if no user-facing commits (
- GitHub Actions is configured as a trusted publisher
- no long-lived npm token is used
- Node needs to be updated to
24.5or higher (npmCLI version11.5.1or higher)
-
nx releaseruns all steps as when we run it manually, i.e.:- skip if there's nothing to release
- generate next version tag from commit history
- update changelog
- push tagged release commit
- build all publishable packages
- publish packages to npm
- create GitHub release with description from changelog
Activity
BioPhoton commentedon Sep 12, 2025
🔥🔥🔥🔥
matejchalk commentedon Sep 24, 2025
Re-opening as it turns out the github action bot can't push to
main(see CI error):I temporarily disabled branch protection to make the
0.80.0release go through on re-run. But it looks like we'll need to authenticate with a GitHub App instead.matejchalk commentedon Sep 26, 2025
Finally got it working 🎉
The fixes are documented in the following PRs:
The
publish.ymlfailed initially because ofreleaseenvironment restrictions tomainbranch. I fixed this by addingv*.*.*tag patterns, and then adding a ruleset which restricts who can push these version tags.I did a final test with our
0.80.2release, both Release and Publish worked as expected.