Skip to content
This repository has been archived by the owner on Apr 17, 2023. It is now read-only.

Latest commit

 

History

History
36 lines (24 loc) · 1.03 KB

Release.md

File metadata and controls

36 lines (24 loc) · 1.03 KB
Raw

Guidelines to contributors for releasing a new version

Run npm run prepare-release command to prepare a release. This uses the standard-version package to do the following.

  1. bumps the version in metadata files (package.json, composer.json, etc),
  2. uses conventional-changelog to update CHANGELOG.md,
  3. commits package.json (et al.) and CHANGELOG.md, and
  4. tags a new release.

In case you want to modify the release in some way, check the documentation of standard-version.

Examples

  • prepare a patch release

    npm run prepare-release -- --release-as patch

  • prepare a minor release

    npm run prepare-release -- --release-as minor

  • prepare a major release

    npm run prepare-release -- --release-as major

Note

It does not by itself deploys the new version to anywhere. That is done automatically by Travis when the changes are pushed to master branch.