Commit 67053176 authored by Stefan Cameron's avatar Stefan Cameron

Add release process

parent 934f0c97
Pipeline #32475948 passed with stages
in 3 minutes and 38 seconds
# RTV.js Releases
The release/publishing process is as follows:
1. Checkout master, rebase, and make sure it's in a clean state _with no pending commits_ not yet pushed to origin.
2. Move all entries under the `[Unreleased]` section in the `/CHANGELOG.md` into a new version section matching the version number that will be released. Leave the `[Unreleased]` section there, empty.
3. Commit changes to `/CHANGELOG.md` using a commit message like `"Changes for version x.y.z"`.
4. Run `npm run release:<major|minor|patch>`. This script will first version `/package.json` and the repo, and will then publish the new release to npm (as long as tests, the build, and docs succeed).
For example, to release a new minor version, run `npm run release:minor`
......@@ -35,7 +35,13 @@
"test:unit:debug": "npm run test:unit -- --inspect-brk",
"test:coverage": "nyc npm run test:unit",
"test": "npm run lint && npm run test:coverage",
"prepublishOnly": "npm test && npm run build && npm run docs"
"preversion": "npm test",
"postversion": "git push && git push --tags",
"prepublish:checkdocs": "git diff HEAD --exit-code -- API.md",
"prepublishOnly": "npm test && npm run build && npm run docs && npm run prepublish:checkdocs",
"release:major": "npm version major -m \"Version %s release\" && npm publish",
"release:minor": "npm version minor -m \"Version %s release\" && npm publish",
"release:patch": "npm version patch -m \"Version %s release\" && npm publish"
},
"repository": {
"type": "git",
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment