Skip to content

Latest commit

 

History

History
84 lines (59 loc) · 3.99 KB

automatically-version-with-conventional-commits.md

File metadata and controls

84 lines (59 loc) · 3.99 KB
Raw

Automatically Version with Conventional Commits

If you wish to bypass the versioning prompt, you can configure Nx Release to defer to the Conventional Commits standard to determine the version bump automatically. This is useful for automating the versioning process in a CI/CD pipeline.

Enable Automatic Versioning

To enable automatic versioning via conventional commits, set the release.version.conventionalCommits property to true in nx.json:

{
  "release": {
    "version": {
      "conventionalCommits": true
    }
  }
}

Determine the Version Bump

Nx Release will use the commit messages since the last release to determine the version bump. It will look at the type of each commit and determine the highest version bump from the following list:

  • 'feat' -> minor
  • 'fix' -> patch

For example, if the git history looks like this:

  - fix(pkg-1): fix something
  - feat(pkg-2): add a new feature
  - chore(pkg-3): update docs
  - chore(release): 1.0.0

then Nx Release will select the minor version bump and elect to release version 1.1.0. This is because there is a feat commit since the last release of 1.0.0. To customize the version bump for different types of commits, or to trigger a version bump with custom commit types, see the Customize Conventional Commit Types recipe.

{% callout type="info" title="No changes detected" %} If Nx Release does not find any relevant commits since the last release, it will skip releasing a new version. This works with independent releases as well, allowing for only some projects to be released and some to be skipped. {% /callout %}

Usage with Independent Releases

If you are using independent releases, Nx Release will determine the version bump for each project independently. For example, if the git history looks like this:

  - fix(pkg-1): fix something
  - feat(pkg-2): add a new feature
  - chore(pkg-3): update docs
  - chore(release): publish

Nx Release will select the patch version bump for pkg-1 and minor for pkg-2. pkg-3 will be skipped entirely, since it has no feat or fix commits.

{% callout type="info" title="Determining if a commit affects a project" %} Note that this determination is made based on files changed by each commit, not by the scope of the commit message itself. This means that feat(pkg-2): add a new feature could trigger a version bump for a project other than pkg-2 if it updated files in another project. {% /callout %}

An example partial output of running Nx Release with independent releases and conventional commits enabled:


NX   Running release version for project: pkg-1

pkg-1 🔍 Reading data for package "@myorg/pkg-1" from packages/pkg-1/package.json
pkg-1 📄 Resolved the current version as 0.4.0 from git tag "[email protected]".
pkg-1 📄 Resolved the specifier as "minor" using git history and the conventional commits standard.
pkg-1 ✍️  New version 0.5.0 written to packages/pkg-1/package.json

NX   Running release version for project: pkg-2

pkg-2 🔍 Reading data for package "@myorg/pkg-2" from packages/pkg-2/package.json
pkg-2 📄 Resolved the current version as 0.4.0 from git tag "[email protected]".
pkg-2 📄 Resolved the specifier as "patch" using git history and the conventional commits standard.
pkg-2 ✍️  New version 0.4.1 written to packages/pkg-2/package.json
pkg-2 ✍️  Applying new version 0.4.1 to 1 package which depends on pkg-2

NX   Running release version for project: pkg-3

pkg-3 🔍 Reading data for package "@myorg/pkg-3" from packages/pkg-3/package.json
pkg-3 📄 Resolved the current version as 0.4.0 from git tag "[email protected]".
pkg-3 🚫 No changes were detected using git history and the conventional commits standard.
pkg-3 🚫 Skipping versioning "@myorg/pkg-3" as no changes were detected.