docs: Document release-related chores! #229
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
akash1810
approved these changes
Feb 3, 2021
akash1810
reviewed
Feb 4, 2021
| @@ -77,6 +77,10 @@ There are more details on using the CDK library in [docs](docs) | |||
| We use [`np`](https://www.npmjs.com/package/np) to help orchestrate the release process. | |||
| To release a new version, run `./script/release`. You will need to be logged in to your `npm` account (`npm login`) which must be part of the Guardian organisation. If you have 2fa enabled, you will be prompted for an OTP during the release process. | |||
|
|
|||
| The script automatically prepares a [GitHub Release](https://docs.github.com/en/github/administering-a-repository/about-releases) and opens a pre-populated form in your browser. Please complete the GitHub Release creation manually. | |||
|
|
|||
| You will also need to manually checkout a new branch and open a PR containing version bump changes which are automatically committed during the release process. | |||
There was a problem hiding this comment.
This works 🎉 (assuming one uses the GitHub CLI).
NEW_VERSION=$(git log -1 --pretty=%B) && git checkout -b release-$NEW_VERSION && gh pr create --title "chore: ${NEW_VERSION}" --body ""
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Adding a couple of notes for forgetful people like me! Obviously this isn't a great process, but at least the docs are now complete. Hopefully we can automate it and avoid these tedious steps soon!