Skip to content
auto Logo

canary

Make a canary release of the project. Useful on PRs. If ran locally, canary will release a canary version for your current git HEAD. This is ran automatically from "shipit".

  1. In PR: 1.2.3-canary.123.0 + add version to PR body
  2. Locally: 1.2.3-canary.1810cfd

Options

FlagTypeDescription
--dry-run, -dBooleanReport what command will do but do not actually do anything
--prNumberPR number to use to create the canary version. Detected in CI env
--buildStringBuild number to use to create the canary version. Detected in CI env
--targetpr-body | comment | statusHow the canary version should be attached to a PR
--message, -mStringMessage to comment on PR with. Defaults to 'Published PR with canary version: %v'. Pass false to disable the comment
--forceBooleanForce a next release, even if the last commit is marked to skip the release
--quiet, -qBooleanPrint only the result of the command

Examples

auto canary
auto canary

auto canary --force
auto canary --force

auto canary --pr 123 --build 5
auto canary --pr 123 --build 5

auto canary --message "Install PR version: `yarn add -D my-project@%v`"
auto canary --message "Install PR version: `yarn add -D my-project@%v`"

auto canary --message false
auto canary --message false

Configurable Options

You can configure some of the options for the canary command in the .autorc.

  • target
  • message
  • force

Example .autorc:

{
  "canary": {
    "target": "pr-body",
    "message": "string",
    "force": true
  }
}
{
  "canary": {
    "target": "pr-body",
    "message": "string",
    "force": true
  }
}