Semantic Release

semantic-release is a set of tools for automating versioning and releasing Node projects.

Installation

Install as a dev dependency:

npm install -D semantic-release

# Plugins need to be installed seperately 
npm install -D @semantic-release/changelog @semantic-release/exec @semantic-release/git

Then in your package.json, configure the steps:

{
  ...,
  "release": {
    "branches": [
      "main"
    ],
    "plugins": [
      [
        "@semantic-release/commit-analyzer",
        {
          "releaseRules": [
            {
              "breaking": true,
              "release": "major"
            },
            {
              "revert": true,
              "release": "patch"
            },
            {
              "type": "feat",
              "release": "minor"
            },
            {
              "type": "*",
              "release": "patch"
            }
          ]
        }
      ],
      "@semantic-release/release-notes-generator",
      "@semantic-release/changelog",
      {
        "path": "@semantic-release/exec",
        "prepareCmd": "npm run compile"
      },
      "@semantic-release/npm",
      [
        "@semantic-release/git",
        {
          "assets": [
            "CHANGELOG.md",
            "package.json"
          ],
          "message": "chore(release): ${nextRelease.version} [skip ci]\n\n${nextRelease.notes}"
        }
      ]
    ]
  }
}

Whenever you would want to release then run the semantic-release executable.