@og_soft/version

Library for automatically bumping Angular applications version based on "ConventionalCommits" (CC) commits history.

Installation

First of all, you need to install the library, when using yarn, you can use following command:

yarn add -D @og_soft/version

Enable version bumping

The version bump is enabled for each project separately, so you need to run the following command for each project you wish to enable versioning:

yarn nx g @og_soft/version:setup PROJECT_NAME

So for instance, if you want to enable versioning for application og-app, you can run following:

yarn nx g @og_soft/version:setup og-app

The command would add the version target to your project configuration. Please note that if your project already has a version target, it will be overwritten (you'll be warned about this).

Running version bump

To bump a new version of your project, just run the version target. So for og-app the command would be:

yarn nx version og-app

The command will bump a project SemVer version based on ConventionalCommits history and update Changelog file accordingly. Also, the git tag for that version will be created.

Version bump command should always be triggered in your default git branch, which is usually main or master.

Also, please make sure to rewrite commit message manually to match the CC format before you squash-merge any Merge Request, otherwise the default message "Merge of xxx" would be used, and the CC changes detection wouldn't work properly.

The executor have few optional configuration parameters. To list them, just run the command with --help argument, for instance:

yarn nx version og-app --help

Additional links

• Conventional Commits
• SemVer

Based on @jscutlery/semver