aboutsummaryrefslogtreecommitdiffstats
path: root/docs/bumping_version.md
blob: df38369a2f2bcff7f519cf6049abe469c0589c7e (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
# How to Bump MetaMask's Version Automatically

```
npm run version:bump patch
```

MetaMask publishes using a loose [semver](https://semver.org/) 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](../development/run-version-bump.js).
The main functions all live [here](../development/version-bump.js).
The test for this behavior is at `test/unit/development/version-bump-test.js`.