@@ -0,0 +1,59 @@
1+## Checklist
2+
3+Helix releases are versioned in the Calendar Versioning scheme:
4+`YY.0M(.MICRO)`, for example `22.05` for May of 2022. In these instructions
5+we'll use `<tag>` as a placeholder for the tag being published.
6+
7+* Merge the changelog PR
8+* Tag and push
9+ * `git tag -s -m "<tag>" -a <tag> && git push`
10+ * Make sure to switch to master and pull first
11+* Edit the `VERSION` file and change the date to the next planned release
12+ * Releases are planned to happen every two months, so `22.05` would change to `22.07`
13+* Wait for the Release CI to finish
14+ * It will automatically turn the git tag into a GitHub release when it uploads artifacts
15+* Edit the new release
16+ * Use `<tag>` as the title
17+ * Link to the changelog and release notes
18+* Merge the release notes PR
19+* Download the macos and linux binaries and update the `sha256`s in the [homebrew formula]
20+ * Use `sha256sum` on the downloaded `.tar.xz` files to determine the hash
21+* Link to the release notes in this-week-in-rust
22+ * [Example PR](https://github.com/rust-lang/this-week-in-rust/pull/3300)
23+* Post to reddit
24+ * [Example post](https://www.reddit.com/r/rust/comments/uzp5ze/helix_editor_2205_released/)
25+
26+[homebrew formula]: https://github.com/helix-editor/homebrew-helix/blob/master/Formula/helix.rb
27+
28+## Changelog Curation
29+
30+The changelog is currently created manually by reading through commits in the
31+log since the last release. GitHub's compare view is a nice way to approach
32+this. For example when creating the 22.07 release notes, this compare link
33+may be used
34+
35+```
36+https://github.com/helix-editor/helix/compare/22.05...master
37+```
38+
39+Either side of the triple-dot may be replaced with an exact revision, so if
40+you wish to incrementally compile the changelog, you can tackle a weeks worth
41+or so, record the revision where you stopped, and use that as a starting point
42+next week:
43+
44+```
45+https://github.com/helix-editor/helix/compare/7706a4a0d8b67b943c31d0c5f7b00d357b5d838d...master
46+```
47+
48+A work-in-progress commit for a changelog might look like
49+[this example](https://github.com/helix-editor/helix/commit/831adfd4c709ca16b248799bfef19698d5175e55).
50+
51+Not every PR or commit needs a blurb in the changelog. Each release section
52+tends to have a blurb that links to a GitHub comparison between release
53+versions for convenience:
54+
55+> As usual, the following is a summary of each of the changes since the last
56+> release. For the full log, check out the git log.
57+
58+Typically, small changes like dependencies or documentation updates, refactors,
59+or meta changes like GitHub Actions work are left out.