release-it-merge

This package is a release-it plugin (using release-it's plugin API) that integrates release-it-merge into the release-it pipeline.

Usage

Installation using your projects normal package manager, for example:

# npm
npm install --save-dev @semabit/release-it-merge

# yarn
yarn add --dev @semabit/release-it-merge

Once installed, configure release-it to use the plugin.

Either via package.json:

{
    "release-it": {
        "plugins": {
          "@semabit/release-it-merge": {}
        }
    }
}

Or via .release-it.json:

{
    "plugins": {
      "@semabit/release-it-merge": {}
    }
}

Configuration

release-it-merge supports configuration options.

For example, given the following configuration (in package.json):

{
    "release-it": {
        "plugins": {
            "@semabit/release-it-merge": {
              "requireCleanWorkingDir": true,
              "requireUpstream": true,
              "sourceBranch": "development",
              "targetBranch": "master",
              "push": true,
              "pushRepo": "origin",
              "merge": true,
              "mergeMessage": "Release v${version}"
            }
        }
    }
}

Each release will run release-it-merge and merges the specified source-branch into the target-branch.