@jscutlery/semver

Nx plugin for versioning using SemVer and CHANGELOG generation powered by Conventional Commits.

Setup

Install

Using Nx:

npm install -D @jscutlery/semver
nx g @jscutlery/semver:install

or if you are using Angular CLI:

ng add @jscutlery/semver

This package allows you to manage your monorepo using one of two modes: Synced or Independent.

Independent mode (default)

Allow multiple projects to be versioned independently. This way you release only what you want and consumers don't get updates they don't need. This allows small, rapid and incremental adoption of your packages.

Synced mode

Allow multiple projects to be versioned in a synced/locked mode. Use this if you want to automatically tie all package versions together. This mode is useful when you are working with only one product.

One issue with this approach is that a major change in any project will result in all projects having a new major version.

Usage

Release

Independent mode

Release project independently by running:

nx run my-project:version [...options]

You can leverage the built-in affected command to only version changed packages:

nx affected --target version [...options]

Synced mode

Release multiple projects at once:

nx run workspace:version [...options]

Specified Level Change

Release a project with a version that is incremented by a specified level. Level can be one of: major, minor, patch, premajor, preminor, prepatch, or prerelease:

nx run workspace:version --version=major
nx run workspace:version --version=minor
nx run workspace:version --version=patch
nx run workspace:version --version=prerelease --preid=alpha
nx run workspace:version --version=prerelease --preid=beta

When run, this command does the following:

1. Retrieve the current version of affected package.json projects.
2. Bump versions based on your commits.
3. Generates CHANGELOGs based on your commits (uses conventional-changelog-angular under the hood).
4. Creates a new commit including your package.json files and updated CHANGELOGs.
5. Creates new tags with the new versions number.
6. Push the releases (if enabled).

Available options:

name	type	default	description
--dry-run	boolean	false	run with dry mode
--no-verify	boolean	false	skip git hooks
--push	boolean	false	push the release
--sync-versions	boolean	false	lock/sync versions between projects
--skip-root-changelog	boolean	false	skip generating root CHANGELOG containing all changes (only with sync mode)
--skip-project-changelog	boolean	false	skip generating project CHANGELOG (only with sync mode)
--changelog-header	string	null	custom Markdown header for CHANGELOGs
--origin	string	'origin'	push against git remote repository
--base-branch	string	'main'	push against git base branch
--version	string	null	specify the level of change
--preid	string	null	prerelease identifier
--version-tag-prefix	string	null	Version tag prefix, defaults are 'v' and '${target}-' for sync and independent modes, ${target} will be replaced with context target value.

Changelog

For new features or breaking changes see the changelog.

Contributors

This project follows the all-contributors specification.

Younes Jaaidi 🐛 💻 📖 💡 🤔	Edouard Bozon 🐛 💻 📖 💡 🤔	Gleb Mikheev 🤔	Richard Lea 💻	Katona 🐛 💻	ntziolis 🐛	RicardoJBarrios 💻 🤔
Sylvain Arnouts 🐛	GethsLeader 💻 🤔	Shahar Kazaz 💻

License

This project is MIT licensed.