chore: add changelog and goose version #544
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
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.
This PR is an experiment to better track unreleased work so when it's time to release we have all the correct bits.
To do so, there is a CHANGELOG.md file at the root, and there's also an "unreleased" version in
main.go, e.g., the latest released version isv3.11.2and so the current version isv3.12.0-dev.Once it's time to release, we update the changelog and bump the version, commit, and tag that commit. Once that's done, we "go back to development" and reset both the changelog and version.
Resetting version means bumping the minor and adding the
-devsuffix.This does add a bit more friction, but ultimately it's a pattern I've seen adopted elsewhere. It's an experiment, if it doesn't work out we'll scrap the idea.
Most of this can be automated with goreleaser and pre- / post- hooks.