Skip to content

jpoehnelt/semantic-release-interval

Repository files navigation

Semantic Release Interval Plugin

npm Build Release codecov GitHub contributors semantic-release

The semantic-release-interval plugin provides functionality to trigger a new release if the oldest commit since the last release is over a certain age.

Read more about Semantic Release.

Note: The release determined by this package does not override any previous release analysis and short circuits if nextRelease is already defined.

Install

$ npm install -D semantic-release-interval

Basic Usage

The following example will generate a release if the oldest commit is more than 1 week old.

{
  "plugins": [
    "@semantic-release/commit-analyzer",
    [
      "semantic-release-interval",
      {
        "units": "week",
        "duration": "1"
      }
    ]
  ]
}

Configuration Options

  • units: The unit of time to use. Can be day, week, month, year or hour.
  • duration: The duration to compare the oldest commit to.
  • release: The release type to use. Can be patch, minor, or major.