1
0
mirror of https://github.com/kremalicious/metamask-extension.git synced 2024-11-25 03:20:23 +01:00
metamask-extension/docs/bumping_version.md
Dan Finlay bf17d7e115 Add version bumping script
One step towards automating our deploy process is automating our version
bumping scheme. This PR does that.
2018-03-02 13:55:56 -08:00

1.1 KiB

How to Bump MetaMask's Version Automatically

npm run version:bump patch

MetaMask publishes using a loose semver interpretation. We divide the three segments of our version into three types of version bump:

Major

Means a breaking change, either an API removed, or a major user expectation changed.

Minor

Means a new API or new user feature.

Patch

Means a fix for a bug, or correcting something that should have been assumed to work a different way.

Bumping the version

npm run version:bump $BUMP_TYPE where $BUMP_TYPE is one of major, minor, or patch.

This will increment the version in the app/manifest.json and CHANGELOG.md files according to our current protocol, where the manifest's version is updated, and any line items currently under the changelog's "master" section are now under the new dated version section.

Modifying the bump script

The script that is executed lives here. The main functions all live here. The test for this behavior is at test/unit/development/version-bump-test.js.