Type object
Schema URL https://catalog.lintel.tools/schemas/schemastore/package-json/_shared/latest--semantic-release.json
Parent schema package-json
Type: object

Properties

extends string | string[]

List of modules or file paths containing a shareable configuration. If multiple shareable configurations are set, they will be imported in the order defined with each configuration option taking precedence over the options defined in a previous shareable configuration

branches string | branch-object | string | branch-object[]

The branches on which releases should happen.

Default:
[
  "+([0-9])?(.{+([0-9]),x}).x",
  "master",
  "next",
  "next-major",
  {
    "name": "beta",
    "prerelease": true
  },
  {
    "name": "alpha",
    "prerelease": true
  }
]
repositoryUrl string

The git repository URL

tagFormat string

The Git tag format used by semantic-release to identify releases. The tag name is generated with Lodash template and will be compiled with the version variable.

Default: "v${version}"
plugins string | array | object[]

Define the list of plugins to use. Plugins will run in series, in the order defined

Default:
[
  "@semantic-release/commit-analyzer",
  "@semantic-release/release-notes-generator",
  "@semantic-release/npm",
  "@semantic-release/github"
]
dryRun boolean

The objective of the dry-run mode is to get a preview of the pending release. Dry-run mode skips the following steps: prepare, publish, success and fail. In addition to this it prints the next version and release notes to the console

ci boolean

Set to false to skip Continuous Integration environment verifications. This allows for making releases from a local machine

Default: true

Definitions

branch-object object
name string required
channel string
range string
prerelease boolean | string