@cp-utils/gitversion
TypeScript icon, indicating that this package has built-in type declarations

0.0.49 • Public • Published

Gitversion

Gitversion is a complete customizable git-based release management system. Primarily focused on package releases.

NPM Version

Key concepts

How does it work

Branch based release strategy

The core concept of gitversion evolves around branch detection and branch types.

Gitversion defines the following types:

  • main/master branch (default branch name 'main')
  • release branches (default matches 'release/*')
  • feature branches (default matches 'feature/*')

The names and detections can be customized to your own need.

Depending on the detected branch types the system will make different choices:

Branch Branch type Version namings (NPM) Release tag Changelog Notes
main main 1.0.0 latest yes Official releases
release/next release 1.0.0‑next.0 next yes (Pre) releases
feature/gh‑1234 feature 1.0.0‑gh‑1234.0 gh‑1234 (*) no Feature release. I.e. to let the customer test the requested feature

You can chose if and how feature releases are released. This can differ from release branches.

Tag based versioning

Like most release systems gitversion will add a tag for each release. This will follow the tag naming with a prefix (default 'v'). I.e.

  • v1.0.0
  • v1.2.3-next.0

The difference of gitversion is that the tags are the only source of truth. It does not care about versions inside files and will keep them even on the default "0.0.0".

There are two main advantages of this strategy:

  • One source of truth. Easy to see in git history what the current state is
  • No more merge conflicts due to mismatches of versions. Otherwise this will happen constantly with feature/release strategies

Gitversion has 2 commands to work with this git-only version strategy:

Restore

yarn gitversion restore

The output will be something like:

gitversion restore

As you see with this you wil get all versions back in package.json files.

Reset

yarn gitversion reset

The output will be something like:

gitversion reset

As you see with this you wil reset all versions back to '0.0.0'.

Conventional commit based bumps

Gitversion works with the concept of a "bump". This is one of the key commands:

yarn gitversion bump

Bump will do the following steps:

  • Restore the current status from git
  • Read the git history and search for Conventional commit style messages
  • Define a bump type based on the outcome
  • Update the workspaces with the new version
  • Udate the workspaces with the workspace specific changelogs
  • Create a bump manifest in the gitversion.out folder containing versions and changelogs

Native monorepo support

Gitversion is build for monorepos with multiple workspaces. It will detect all (public) workspaces and use them during bump.

There are 2 main operation modes:

Global versioning

This is the default mode. This will keep all versions of all workspaces the same. This is useful for monorepos with series of packages (i.e. '@aws-sdk/'*)

Independent versioning

This will use unique versions per workspace in the mono repo. Based on the path of the committed files it will decide if the specific workspace needs a bump and which bump type.

Split stage publish

Gitversion is buld for usage within CI/CD pipelines. When building packages gitversion can be used in a pipeline like this:

Pipeline

This will allow you to run your time consuming steps in parallel with your build step. Only when all checks pass you have a (quick) publish stage.

Package Sidebar

Install

npm i @cp-utils/gitversion

Weekly Downloads

19

Version

0.0.49

License

Apache-2.0

Unpacked Size

313 kB

Total Files

91

Last publish

Collaborators

  • joostvdwaalsd
  • abelmokadem