From 36ef533384a90792fcf80e2e6726be252f08ca48 Mon Sep 17 00:00:00 2001 From: Stephanie Hobson Date: Mon, 25 Feb 2019 10:13:23 -0800 Subject: [PATCH] Update deployment docs --- docs/README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/README.md b/docs/README.md index 451e4f3a..d84b5ffe 100755 --- a/docs/README.md +++ b/docs/README.md @@ -505,10 +505,10 @@ npm test Protocol is published to NPM under the `@mozilla-protocol/core` namespace/package name. To publish a release to NPM, use the following steps: -1. Update the `version` number in [package.json][package.json] (use [Semantic Versioning][semver] to determine what the new version number should be). -2. Update the accompanying [README.md][readme]. -3. Make sure [CHANGELOG.md][changelog] is also up to date. -4. Commit the changes to the `master` branch. +1. Before you start make sure the project's [CHANGELOG.md][changelog] is up to date. +2. Update the package `version` number in [src/assets/package/package.json][package.json] (use [Semantic Versioning][semver] to determine what the new version number should be). +3. Update the package README [assets/package/README.md][readme]. +4. Submit a pull request with your changes (or commit directly to `master` if you have permission). Once the changes have been merged to master: 5. Tag a new release. You can do this either using [Git tag][git-tag], or directly on the [GitHub website][releases]. 6. Run `npm test` to run the build script and front-end tests. The package contents will be located in `./dist/assets/protocol/`. 7. If the build is successful and all tests pass, publish to NPM using `npm publish ./dist/assets/protocol/`.