Skip to content

Commit 5600734

Browse files
committed
Update HACKING.md
1 parent e9463f7 commit 5600734

File tree

1 file changed

+12
-2
lines changed

1 file changed

+12
-2
lines changed

HACKING.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -106,6 +106,14 @@ This will generate an HTML representation of code coverage throughout the repo t
106106

107107
### Release Process
108108

109+
#### Prerequisites
110+
111+
Ensure that you have gnupg configured, along with a key generated. On macOS, you should install `gnupg` and `pinentry-mac` from Homebrew.
112+
113+
If you have not generated a key before, follow the instructions from [GitHub Docs on Generating a new GPG key](https://docs.github.com/en/free-pro-team@latest/github/authenticating-to-github/generating-a-new-gpg-key).
114+
115+
#### Releasing
116+
109117
To release snooty, do the following:
110118

111119
1. Make sure you are on the `master` branch.
@@ -129,8 +137,10 @@ To release snooty, do the following:
129137
4. Go to <https://github.com/mongodb/snooty-parser/releases/> to locate the newly-created
130138
release.
131139

132-
5. Copy the appropriate section from CHANGELOG.md into the release description, and
133-
check the _This is a pre-release_ checkbox.
140+
5. Copy the appropriate section from CHANGELOG.md into the release description,
141+
check the _This is a pre-release_ checkbox, and create the release.
142+
143+
6. Push your branch.
134144

135145
If there is an error, use `git reset --hard <previous_commit_hash>` to revert any
136146
commits that might have been made, and

0 commit comments

Comments
 (0)