You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: HACKING.md
+12-2Lines changed: 12 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -106,6 +106,14 @@ This will generate an HTML representation of code coverage throughout the repo t
106
106
107
107
### Release Process
108
108
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
+
109
117
To release snooty, do the following:
110
118
111
119
1. Make sure you are on the `master` branch.
@@ -129,8 +137,10 @@ To release snooty, do the following:
129
137
4. Go to <https://github.com/mongodb/snooty-parser/releases/> to locate the newly-created
130
138
release.
131
139
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.
134
144
135
145
If there is an error, use `git reset --hard <previous_commit_hash>` to revert any
0 commit comments