Description
When managing a collection of projects you often want to follow a standard CHANGELOG template for all of them, but you also do not want to have to setup the release flow for every package. This is where cliff-jumper comes in.
How this works
cliff-jumper uses a combination of conventional-recommended-bump and git-cliff to bump your package using semantic versioning (following the Angular preset). It will:
- Perform preflight checks to verify that the tool can run
- Resolve which bump strategy should be used by using conventional-recommended-bump
- If the CLI tool is ran inside a mono repo then only commits that affect the nested package will be considered!
- Bump the version in your
package.jsonusingnpm versionwith the resolved strategy - Validate that
-t,--skip-tag(CLI flags) weren't provided orskipTagwasn't set totruein the config file - Update the
CHANGELOG.mdfile using git-cliff - Stage the
package.jsonandCHANGELOG.mdfiles - Commit the release
- Tag the release
Installation
You can use the following command to install this package, or replace npm install -D with your package manager of choice.
npm install -D @favware/cliff-jumper
Or install it globally:
npm install -g @favware/cliff-jumper
Then call the script with cliff-jumper or cj:
cliff-jumper --name "my-package" --package-path "." # Add any other flags or use --help
cj --name "my-package" --package-path "." # Add any other flags or use --help
Alternatively you can call the CLI directly with npx:
npx @favware/cliff-jumper --name "my-package" --package-path "." # Add any other flags or use --help
Usage
You can provide all options through CLI flags:
Usage: cliff-jumper [options]
Options:
-V, --version output the version number
-n, --name <string> The package name to release
-p, --package-path <string> The path to the current package. For non-monorepos this is just "."
--dry-run Whether the package should be bumped or not. When this is set no actions will be taken and only the release strategy will be logged
--first-release Whether this is the first release (skips bumping the version)
--mono-repo Whether the package to be bumped resides in a mono repo,
which enables Lerna-like scanning for what kind of version bump should be applied
Defaults to "true" when "org" is set, false otherwise
--no-mono-repo Whether the package to be bumped resides in a mono repo,
which enables Lerna-like scanning for what kind of version bump should be applied
Defaults to "true" when "org" is set, false otherwise
-o, --org <string> The NPM org scope that should be used WITHOUT "@" sign or trailing "/"
--preid [string] The "prerelease identifier" to use as a prefix for the "prerelease" part of a semver
-c, --commit-message-template [string] A custom commit message template to use.
Defaults to "chore({{name}}): release {{full-name}}@{{new-version}}"
You can use "{{new-version}}" in your template which will be dynamically replaced with whatever the new version is that will be
published.
You can use "{{name}}" in your template, this will be replaced with the name provided through "-n", "--name" or the same value set in
your config file.
You can use "{{full-name}}" in your template, this will be replaced "{{name}}" (when "org" is not provided), or "@{{org}}/{{name}}"
(when "org" is provided).
--skip-changelog Whether to skip updating your CHANGELOG.md
default "true" when CI=true, "false" otherwise (default: false)
-t, --skip-tag Whether to skip creating a git tag
default "true" when CI=true, "false" otherwise (default: false)
-v, --verbose Whether to print verbose information (default: false)
-h, --help display help for command
Or, you can set most of these options through a configuration file. This file should be located at your current working directory (where you're calling this package). It should be named .cliff-jumperrc, optionally suffixed with .json, .yaml, or .yml.
Config file fields
--namemaps toname--package-pathmaps topackagePath--dry-runmaps todryRun--first-releasemaps tofirstRelease--mono-repoand--no-mono-repomap tomonoRepo--orgmaps toorg--preidmaps topreid--commit-message-templatemaps tocommitMessageTemplate--skip-changelogmaps toskipChangelog--skip-tagmaps toskipTag--verbosemaps toverbose
When using .cliff-jumperrc or .cliff-jumperrc.json as your config file you can also use the JSON schema to get schema validation. To do so, add the following to your config file:
{
"$schema": "https://raw.githubusercontent.com/favware/cliff-jumper/main/assets/cliff-jumper.schema.json"
}
Example JSON file:
{
"$schema": "https://raw.githubusercontent.com/favware/cliff-jumper/main/assets/cliff-jumper.schema.json",
"name": "my-package",
"packagePath": ".",
"verbose": true
}
Example YAML file:
name: my-package
packagePath: .
verbose: true
Default values
This library has opinionated defaults for its options. These are as follows:
--dry-runwill default toundefined.--first-releasewill default toundefined.--orgwill default toundefined.--preidwill default toundefined.--skip-changelogwill default tofalse(truewhenCIenvironment variable is'true').--skip-tagwill default tofalse(truewhenCIenvironment variable is'true').--mono-repowill default totruewhenorgis set, orfalsewhen it's not. Alternatively you can force this to false by providing--no-mono-repo.--commit-message-templatewill default tochore({{name}}): release {{full-name}}@{{new-version}}{{new-version}}will be replaced with the new version that will be published{{name}}will be replaced with the name provided through-n,--nameor the same value set in your config file{{full-name}}will be replaced with{{name}}(whenorgis not provided), or@{{org}}/{{name}}(whenorgis provided).
--verbosewill default tofalse.
Merging of config file, defaults and CLI provided flags
When you have a config file the options in the file are merged with the default options and with any other provided CLI flags. Which source takes highest priority depends on the type of the option. The priority is as follows (lower means it gets lower priority):
- CLI flags
- Default values
- Config file
This means that the CLI flags will always have the highest priority. This way you can have a config file for base options, then overwrite that with CLI flags, such as in a CI environment.
Buy us some doughnuts
Favware projects are and always will be open source, even if we don't get donations. That being said, we know there are amazing people who may still want to donate just to show their appreciation. Thank you very much in advance!
We accept donations through Ko-fi, Paypal, Patreon, GitHub Sponsorships, and various cryptocurrencies. You can use the buttons below to donate through your method of choice.
| Donate With | Address |
|---|---|
| Ko-fi | Click Here |
| Patreon | Click Here |
| PayPal | Click Here |
| GitHub Sponsors | Click Here |
| Bitcoin | 1E643TNif2MTh75rugepmXuq35Tck4TnE5 |
| Ethereum | 0xF653F666903cd8739030D2721bF01095896F5D6E |
| LiteCoin | LZHvBkaJqKJRa8N7Dyu41Jd1PDBAofCik6 |
Contributors
β¨
Thanks goes to these wonderful people (emoji key):
 Jeroen Claassens |
This project follows the all-contributors specification. Contributions of any kind welcome!
129 May 8, 2022
4 Nov 28, 2022
2 Jan 4, 2022
335 Oct 1, 2022
3 Feb 23, 2022
14 Aug 11, 2021
12.7k Jan 4, 2023
2 Jan 31, 2022
21 Mar 19, 2022
27 Apr 12, 2022
2 Jun 25, 2022
22 Jul 1, 2022
20 Nov 16, 2022
12.2k Dec 30, 2022
189 Dec 14, 2022
3 Dec 29, 2022
1.7k Dec 10, 2022
51 Dec 13, 2022
26 Dec 27, 2022