v0.17.0

0.17.0 (2020-03-06)

BREAKING CHANGE

This version introduces some breaking changes.

• In your ship.config.js, rename pullRequestReviewer to pullRequestReviewers (which accepts only an array of strings).

• In your ship.config.js, rename pullRequestTeamReviewer to pullRequestTeamReviewers (which accepts only an array of strings).

• releaseStart for Slack message has been removed. If you'd like to have it back, please create an issue and let's discuss.

• The default value of testCommandBeforeRelease is now undefined. It used to be ({ isYarn }) => isYarn ? 'yarn test' : 'npm run test'. This change assumes many of you already run tests with CI services when you create pull requests. With the previous config, Ship.js unnecessarily ran tests before release. If you'd like to have it back, add some config like the following:

testCommandBeforeRelease: ({ isYarn }) => isYarn ? 'yarn test' : 'npm run test',

Bug Fixes

• setup: do not write ship.config.js if not necessary (#705) (82f8cbc)

• setup: fix wrong config(packagesToBump, packagesToPublish) for monorepo (#701) (0590a38)

• clean up reviewer related configs (#707) (833d684)

• allow @(a|b|c) syntax for packagesToBump and packagesToPublish (#702) (de9083c)

• remove releaseStart hook for slack message (#703) (2a9502b)

• create CHANGELOG if missing (#697) (72cb4ec)

• empty testCommandBeforeRelease by default (#696) (34753b0)

• shipjs-lib: exclude dependencies from final bundle (#651) (f6ec4cf)

• check nullable value for reviewers (#709) (df7c0be)

v0.16.1

0.16.1 (2020-03-03)

Bug Fixes

• setup: use .prettierrc if exists (#681) (39b93be)

v0.16.0

0.16.0 (2020-02-25)

Bug Fixes

• detect major versions correctly (#666) (5c5cca1), closes #634
• pass version to buildCommand (#676) (c25b49b)

Features

• error: tell user where to create a GitHub token (#665) (901fcd8)

v0.15.0

0.15.0 (2020-02-03)

Features

• add environment variable SHIPJS=true (#647) (582df3c)
• prepare: add shouldPrepare (#654) (166626d)

shouldPrepare

default: undefined

// example
shouldPrepare: ({
                  commits,
                  nextVersion,
                  releaseType,
                  releaseTag,
                  commitNumbersPerType,
               }) => { /* ... */ }

This is a lifecycle hook where you can decide whether or not to proceed with the preparation.

Read the guide to learn more about the hook.

v0.14.2

0.14.2 (2020-01-27)

Bug Fixes

• add version in buildCommand hook (#640) (420dbb9)

v0.14.1

0.14.1 (2020-01-22)

Bug Fixes

• clean up all cases for releaseType (#631) (89e5d73)
• pass releaseTag to afterPublish hook (#632) (6b5febb)

releaseType

The following shows how releaseType is determined.

normal cases

• 1.2.3 -> 2.0.0: major
• 1.2.3 -> 1.3.0: minor
• 1.2.3 -> 1.2.4: patch

next version has a tag

• 1.2.3 -> 1.2.4-alpha.0: prerelease
• 1.2.4-alpha.0 -> 1.2.4-alpha.1: prerelease

version with a tag -> version without one

• 1.2.4-alpha.0 -> 1.2.4: patch
• 1.2.4-alpha.0 -> 1.2.5: patch
• 1.2.4-alpha.0 -> 1.3.0: minor
• 1.2.4-alpha.0 -> 2.0.0: major
• 1.3.0-alpha.0 -> 1.3.0: minor
  Just like normal cases, the new version decides the releaseType.

v0.14.0

0.14.0 (2020-01-14)

Bug Fixes

• release: add version in afterPublish hook (#608) (76c5591)
• action: pin GitHub Action versions (#612) (b5e576a)
• action: replace switch with build in checkout (#602) (ef5f8b9)
• slack: use tag name instead of release tag (#609) (f183425)

Features

• prepare: provide a config to assign team as reviewer (#619) (14ebf38)

v0.13.1

0.13.1 (2019-12-31)

Bug Fixes

• trigger: fix a bug it threw an exception at finished step (#581) (eb60e56)

v0.13.0

0.13.0 (2019-12-31)

Bug Fixes

• github-actions: fix image name (#557) (33f710c)
• replace GH_TOKEN with GITHUB_TOKEN (#568) (835e26f)
• prepare: throw with --yes when git tag is missing (#570) (cee5f35)

Features

• prepare: add --commit-from option (#572) (041d3d9)
• release: notify GitHub release url instead of CHANGELOG (#555) (c017067), closes #506

v0.12.1

0.12.1 (2019-12-24)

Bug Fixes

• setup: add SLACK_INCOMING_HOOK env for all GitHub Actions (#550) (dbdd919)
• setup: don't use escape for config serializion (#549) (59b802d)