feat(release): revamped nx release version implementation by JamesHenry · Pull Request #30418 · nrwl/nx

JamesHenry · 2025-03-18T21:21:02Z

This PR provides a new implementation for the versioning stage of nx release which brings a ton of benefits.

Previously unsupported/impossible features now available:

It is possible to have dependencies which flow across release group boundaries, therefore updateDependents will work across group boundaries as well.
It is possible to update multiple manifests (such as package.json) for a single versioning execution. For example, updating the version and dependencies in both your source and dist package.json for a project.

Massively improved extensibility for non-JS languages/ecosystems:

The ReleaseVersionGenerator abstraction was distinctly suboptimal because it required each plugin to reimplement a bunch of core business logic related to resolving tags from git, combining current versions and specifiers to produce new semver values, deleting version plans after use etc.
- It is now been replaced by the VersionActions class, which exclusively deals with the aspects that make that language/ecosystem unique, such as reading and writing from a manifest file (such as package.json/Cargo.toml etc) if applicable, reading from a remote registry etc.
- No core business logic about releases is handled within a VersionActions implementation.
- You can check out the implementation for JS projects here: packages/js/src/generators/release-version/version-actions.ts

Other benefits:

More performant
Much better IDE experience for version configuration because of the untyped generatorOptions going away, and most options moving to the top level of release.version config in nx.json.
More informative logs during versioning, e.g.
- BEFORE: Resolved the specifier as "minor" using version plans.
- AFTER: Applied semver relative bump "minor", read from version plan .nx/version-plans/bump-mixed1.md, to get new version 0.2.0
Lays the groundwork for application releases becoming a first-class use-case as part of our 2025 Roadmap.
preserveLocalDependencyProtocols is now true by default and can be omitted from end user configs.

Notes on rollout

In Nx v20, it is opt-in via setting "useLegacyVersioning": false in release.version in nx.json.
It will be enabled by default in Nx v21, with opt-out still possible via setting the flag explicitly to true.
We will provide an automated migration to the new configuration as part of Nx v21
The legacy versioning can now be considered "frozen". Some bugs should be fixed by moving to the new versioning, and any future fixes will be applied there.
In Nx v22, the legacy versioning will be entirely removed.
Documentation updates will take place in a follow up PR which documents both approaches, whilst making it clear that the legacy versioning is being replaced.

You can see how straightforward it was to manually apply using the PR release from this branch on a real world project here: angular-eslint/angular-eslint#2329

Fixes #21458
Fixes #21466
Fixes #26444
Fixes #27823
Fixes #28049
Fixes #28695
Fixes #30363

vercel · 2025-03-18T21:21:06Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Updated (UTC)
nx-dev	✅ Ready (Inspect)	Visit Preview	Apr 8, 2025 0:56am

nx-cloud · 2025-03-18T21:21:46Z

View your CI Pipeline Execution ↗ for commit 15a27dc.

Command	Status	Duration	Result
`nx affected --targets=lint,test,build,e2e,e2e-c...`	✅ Succeeded	5m 44s	View ↗
`nx run-many -t check-imports check-commit check...`	✅ Succeeded	19s	View ↗
`nx-cloud record -- nx format:check --base=2fd96...`	✅ Succeeded	4s	View ↗
`nx-cloud record -- nx-cloud conformance:check`	✅ Succeeded	3s	View ↗
`nx-cloud record -- nx sync:check`	✅ Succeeded	<1s	View ↗
`nx documentation`	✅ Succeeded	<1s	View ↗

☁️ Nx Cloud last updated this comment at 2025-04-08 14:00:57 UTC

FrozenPandaz · 2025-03-26T22:43:48Z

+export default class JsVersionActions extends VersionActions {
+  manifestFilename = 'package.json';
+
+  static createAfterAllProjectsVersionedCallback(


nit: not a fan of this method name. Is postVersioning callback a better name?

It is now an exported function as discussed. I couldn't help feeling like afterAllProjectsVersioned is a clearer name because it's not after all of the version logic runs (it's before git for example), so postVersion felt a little ambiguous

But I have indeed been able to flatten it now too and avoid the higher order function

github-actions · 2025-03-27T20:42:49Z

🐳 We have a release for that!

This PR has a release associated with it. You can try it out using this command:

npx [email protected] my-workspace

Or just copy this version and use it in your own command:

0.0.0-pr-30418-80f02f7

Release details	📑
Published version	0.0.0-pr-30418-80f02f7
Triggered by	@JamesHenry
Branch	nx-release-v-v2
Commit	80f02f7
Workflow run	14115494427

To request a new release for this pull request, mention someone from the Nx team or the @nrwl/nx-pipelines-reviewers.

github-actions · 2025-03-28T19:07:52Z

🐳 We have a release for that!

This PR has a release associated with it. You can try it out using this command:

npx [email protected] my-workspace

Or just copy this version and use it in your own command:

0.0.0-pr-30418-6fbe6c1

Release details	📑
Published version	0.0.0-pr-30418-6fbe6c1
Triggered by	@JamesHenry
Branch	nx-release-v-v2
Commit	6fbe6c1
Workflow run	14135844180

To request a new release for this pull request, mention someone from the Nx team or the @nrwl/nx-pipelines-reviewers.

CatsMiaow · 2025-04-04T05:56:44Z

hello.
Could this PR also provide a setting to add a force option to gitPush? Maybe by adding a gitPushArgs option?

The above error can be solved with force push, but there is no push option provided.

nx/packages/nx/src/command-line/release/utils/git.ts

Lines 424 to 432 in 6e50a01

    
           const commandArgs = [ 
        
             'push', 
        
             // NOTE: It's important we use --follow-tags, and not --tags, so that we are precise about what we are pushing 
        
             '--follow-tags', 
        
             '--no-verify', 
        
             '--atomic', 
        
             // Set custom git remote if provided 
        
             ...(gitRemote ? [gitRemote] : []), 
        
           ];

Scripted, it would look like this
Currently, we have the gitCommitArgs and gitTagsArgs options, but not the gitPushArgs option.

import { releaseVersion } from 'nx/release';

const version = await releaseVersion({
  verbose: true,
  gitTag: true,
  gitTagArgs: [],
  gitCommit: true,
  gitCommitArgs: [],
  gitPush: true,
  gitPushArgs: ['-f'], // or gitPushForce: true
  gitRemote: 'origin',
  firstRelease: true,
});

github-actions · 2025-04-08T12:42:59Z

🐳 We have a release for that!

This PR has a release associated with it. You can try it out using this command:

npx [email protected] my-workspace

Or just copy this version and use it in your own command:

0.0.0-pr-30418-d6cd6b6

Release details	📑
Published version	0.0.0-pr-30418-d6cd6b6
Triggered by	@JamesHenry
Branch	nx-release-v-v2
Commit	d6cd6b6
Workflow run	14333346914

To request a new release for this pull request, mention someone from the Nx team or the @nrwl/nx-pipelines-reviewers.

github-actions · 2025-04-14T00:10:52Z

This pull request has already been merged/closed. If you experience issues related to these changes, please open a new issue referencing this pull request.

vercel Bot deployed to Preview March 18, 2025 21:30 View deployment

JamesHenry force-pushed the nx-release-v-v2 branch from 4e2b721 to 0e58904 Compare March 19, 2025 12:15

vercel Bot deployed to Preview March 19, 2025 12:24 View deployment

vercel Bot deployed to Preview March 19, 2025 16:05 View deployment

JamesHenry force-pushed the nx-release-v-v2 branch from ade2b66 to 0eba509 Compare March 19, 2025 17:32

vercel Bot deployed to Preview March 19, 2025 17:42 View deployment

nrwl deleted a comment from github-actions Bot Mar 19, 2025

vercel Bot had a problem deploying to Preview March 21, 2025 11:53 Failure

vercel Bot deployed to Preview March 21, 2025 14:55 View deployment

JamesHenry force-pushed the nx-release-v-v2 branch from 35f507b to 4f79396 Compare March 21, 2025 19:02

JamesHenry changed the title ~~chore(core): wip~~ feat(release): revamped nx release version implementation Mar 21, 2025

vercel Bot deployed to Preview March 21, 2025 19:11 View deployment

vercel Bot deployed to Preview March 23, 2025 09:23 View deployment

vercel Bot deployed to Preview March 23, 2025 11:48 View deployment

JamesHenry force-pushed the nx-release-v-v2 branch from 45698b3 to dcb8ea4 Compare March 24, 2025 08:51

vercel Bot deployed to Preview March 24, 2025 08:59 View deployment

JamesHenry force-pushed the nx-release-v-v2 branch from dcb8ea4 to 2630702 Compare March 24, 2025 09:58

feat(release): revamped nx release version implementation

e91f47d

JamesHenry force-pushed the nx-release-v-v2 branch from 2630702 to e91f47d Compare March 24, 2025 10:02

vercel Bot deployed to Preview March 24, 2025 10:14 View deployment

nrwl deleted a comment from github-actions Bot Mar 24, 2025

JamesHenry marked this pull request as ready for review March 24, 2025 12:49

JamesHenry requested review from a team, mandarini, meeroslav and vsavkin as code owners March 24, 2025 12:49

JamesHenry added 3 commits March 27, 2025 18:29

fix(release): update core VersionActions

8502081

chore(release): fix comment

891febb

Merge branch 'master' into nx-release-v-v2

9244863

vercel Bot deployed to Preview March 27, 2025 15:05 View deployment

FrozenPandaz requested changes Mar 27, 2025

View reviewed changes

JamesHenry added 3 commits March 27, 2025 22:51

fix(release): version actions API adjustments

1966032

chore(core): fix message

80f02f7

chore(core): fix message

0a0f4e0

nrwl deleted a comment from github-actions Bot Mar 27, 2025

JamesHenry added 3 commits March 28, 2025 13:48

chore(core): logging improvements

aa4cdbf

chore(core): ensure afterAllProjectsVersioned is optional

408388e

chore(core): wip non-semver support

6fbe6c1

JamesHenry added 3 commits April 8, 2025 12:54

chore(core): support .ts implementations of VersionActions

456e0b9

feat(core): support gitPushArgs for release

f39c791

Merge branch 'master' into nx-release-v-v2

d6cd6b6

vercel Bot had a problem deploying to Preview April 8, 2025 12:22 Failure

chore(core): update docs

15a27dc

JamesHenry requested a review from a team as a code owner April 8, 2025 12:46

vercel Bot deployed to Preview April 8, 2025 12:56 View deployment

FrozenPandaz approved these changes Apr 8, 2025

View reviewed changes

JamesHenry merged commit 7b85d91 into master Apr 8, 2025

JamesHenry deleted the nx-release-v-v2 branch April 8, 2025 14:17

github-actions Bot locked as resolved and limited conversation to collaborators Apr 14, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(release): revamped nx release version implementation#30418

feat(release): revamped nx release version implementation#30418
JamesHenry merged 14 commits into
masterfrom
nx-release-v-v2

JamesHenry commented Mar 18, 2025 •

edited

Loading

Uh oh!

vercel Bot commented Mar 18, 2025 •

edited

Loading

Uh oh!

nx-cloud Bot commented Mar 18, 2025 •

edited

Loading

Uh oh!

FrozenPandaz Mar 26, 2025

Uh oh!

JamesHenry Mar 27, 2025

Uh oh!

JamesHenry Mar 27, 2025

Uh oh!

Uh oh!

github-actions Bot commented Mar 27, 2025

Uh oh!

github-actions Bot commented Mar 28, 2025

Uh oh!

CatsMiaow commented Apr 4, 2025

Uh oh!

github-actions Bot commented Apr 8, 2025

Uh oh!

github-actions Bot commented Apr 14, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

JamesHenry commented Mar 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

vercel Bot commented Mar 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

nx-cloud Bot commented Mar 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

FrozenPandaz Mar 26, 2025

Choose a reason for hiding this comment

Uh oh!

JamesHenry Mar 27, 2025

Choose a reason for hiding this comment

Uh oh!

JamesHenry Mar 27, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

github-actions Bot commented Mar 27, 2025

🐳 We have a release for that!

Uh oh!

github-actions Bot commented Mar 28, 2025

🐳 We have a release for that!

Uh oh!

CatsMiaow commented Apr 4, 2025

Uh oh!

github-actions Bot commented Apr 8, 2025

🐳 We have a release for that!

Uh oh!

github-actions Bot commented Apr 14, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

JamesHenry commented Mar 18, 2025 •

edited

Loading

vercel Bot commented Mar 18, 2025 •

edited

Loading

nx-cloud Bot commented Mar 18, 2025 •

edited

Loading