Skip to content

Commit 8fc6fc2

Browse files
authored
Merge pull request #378 from puppetlabs/development
Add publishing instructions to CONTRIBUTING.md
2 parents 7e9588f + dc2d5f7 commit 8fc6fc2

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

CONTRIBUTING.md

+6-1
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,12 @@ Each PR should get a +1 before being merged into `development`. The [design-syst
6161

6262
## Publishing
6363

64-
New versions are currently released by maintainers using `npm run release`. Please collaborate with the team to release a new version. (Note: This process will likely be replaced with automated releases on push to master.)
64+
1. Create a PR from `development` to `master`.
65+
2. Increment the version in the appropriate package.json file (e.g. [packages/react-components/package.json](packages/react-components/package.json)), following [semver](https://semver.org).
66+
3. Run `npm install` so that package-lock.json files also get updated.
67+
3. Update the [CHANGELOG.md](CHANGELOG.md).
68+
4. Get a +1 and merge the PR to master, which will trigger a Relay workflow that runs the `npm run release` command.
69+
5. Verify the new version got published, e.g. by checking [https://www.npmjs.com/package/@puppet/react-components](https://www.npmjs.com/package/@puppet/react-components)
6570

6671
### Prerequisites
6772

0 commit comments

Comments
 (0)