Improve README guidance for release process #188
Conversation
**Why**: - Changelog should be edited to replace "Unreleased" with the release version. - Main branch is protected, so you cannot commit the version bump directly. Improve text to include steps for creating a branch, opening a pull request, and merging before creating a new release. - Dry-run testing is all well and good, but there wasn't any guidance around what exactly one should be looking for in considering whether "everything looks alright".
README.md
Outdated
| 6. If everything looks alright, continue with publishing by running `npm publish`. | ||
| 7. Create a new release on the [GitHub "Releases" page](https://github.com/18F/identity-style-guide/releases). | ||
| - Consider: In the files listed, are there any that should or shouldn't be included? Does the version match what you expect? | ||
| 8. If everything looks alright, continue with publishing by running `npm publish`. |
There was a problem hiding this comment.
We have a handbook page that links to a google doc that lists who has access to NPM to be able to publish, should we link to that from here?
There was a problem hiding this comment.
We have a handbook page that links to a google doc that lists who has access to NPM to be able to publish, should we link to that from here?
I shuffled this a bit in 39fc4e0 to include a leading "prerequisites" blurb of text:
Before starting, make sure that all changes intended for release should be merged into the
mainbranch. You will need permissions to publish the package to npm. Check current package owners by runningnpm owner lsor by consulting the list of admins through the Services and Accounts handbook page. If you do not have access, contact an owner to have access granted or to publish on your behalf.
Why: