Configuration

Customize Shipmark to fit your workflow.

Configuration File

Shipmark uses .shipmarkrc.yml in your project root. Create one with:

$ shipmark init

Full Configuration Example

changelog:
  file: "CHANGELOG.md"
  includeHash: true
  includeDate: true

version:
  files: ["package.json"]
  tagPrefix: "v"
  tagMessage: "Release {version}"
  commitMessage: "chore(release): {version}"

commits:
  conventional: true

git:
  push: true
  pushTags: true
  signTags: false
  signCommits: false

Configuration Options

changelog

Option Type Default Description
file string "CHANGELOG.md" Changelog file path
includeHash boolean true Include commit hashes in changelog
includeDate boolean true Include release date in header
includeAuthor boolean false Include commit author

version

Option Type Default Description
files string[] ["package.json"] Files to update version in
tagPrefix string "v" Prefix for git tags
tagMessage string "Release {version}" Tag annotation message
commitMessage string "chore(release): {version}" Release commit message

git

Option Type Default Description
push boolean true Push commits to remote
pushTags boolean true Push tags to remote
signTags boolean false GPG sign tags
signCommits boolean false GPG sign commits