add release checklist and changelog curation docs #2598
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
archseer
reviewed
May 29, 2022
docs/releases.md
Outdated
| * `git tag -s -m "<tag>" -a <tag> && git push` | ||
| * Make sure to switch to master and pull first | ||
| * Edit the `VERSION` file and add back the `-dev` and change the date to the next planned release | ||
| * Releases are planned to happen every two months, so `22.05` should be changed to `22.07-dev` in this step |
There was a problem hiding this comment.
Let's switch back to bumping the version on release. It makes the workflow a bit simpler, we'll just need to be more careful when reading github issues to distinguish dev vs stable. Perhaps we can add that as a field to the debug template?
thomasskk
pushed a commit
to thomasskk/helix
that referenced
this pull request
Sep 9, 2022
* add release checklist and changelog curation docs * remove step for deleting '-dev' suffix from VERSION
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.
To make the release a bit smoother next time, styled like https://github.com/BurntSushi/ripgrep/blob/master/RELEASE-CHECKLIST.md. I also added some notes on curating the changelog but I'll be happy to cover that for 22.07 as well 🙂. I'll probably push a
22.07-changelogbranch some time next week.