1fd3dc9ecf
As a solution to the constant lockfile churn issues we've had with `npm`, the project now uses `yarn` to manage dependencies. The `package-lock.json` file has been replaced with `yarn.lock`, which was created using `yarn import`. It should approximate the contents of `package-lock.json` fairly well, though there may be some changes due to deduplication. The codeowners file has been updated to reference this new lockfile. All documentation and npm scripts have been updated to reference `yarn` rather than `npm`. Note that running scripts using `npm run` still works fine, but it seemed better to switch those to `yarn` as well to avoid confusion. The `npm-audit` Bash script has been replaced with `yarn-audit`. The output of `yarn audit` is a bit different than `npm audit` in that it returns a bitmask to describe which severity issues were found. This made it simpler to check the results directly from the Bash script, so the associated `npm-audit-check.js` script was no longer required. The output should be exactly the same, and the information is still sourced from the same place (the npm registry). The new `yarn-audit` script does have an external dependency: `jq`. However, `jq` is already assumed to be present by another CI script, and is present on all CI images we use. `jq` was not added to `package.json` as a dependency because there is no official package on the npm registry, just wrapper scripts. We don't need it anywhere exept on CI anyway. The section in `CONTRIBUTING` about how to develop inside the `node_modules` folder was removed, as the advice was a bit dated, and wasn't specific to this project anyway.
1.1 KiB
How to Bump MetaMask's Version Automatically
yarn 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
yarn 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.