Introduce changie for CHANGELOG management & releases #3
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
luislavena
changed the title
Aims to help with the CHANGELOG generation and tracking to ensure each new release contains the necessary information for other developers while keep a documented history of the project itself.
luislavena
force-pushed
the
introduce-changie
branch
from
4fc6f2d
to
043181a
Compare
GitHub workflow that verifies if CHANGELOG 'changes' are part of the PR.
Add manual workflow that generates a release PR
Tag and push a new release once the CHANGELOG changes are merged back into `main` branch. Pending building binaries and attaching the artifacts to the release.
luislavena
force-pushed
the
introduce-changie
branch
from
043181a
to
38c3b1e
Compare
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.
Keep track of changes on this project and help organize them using changie to keep and maintain the CHANGELOG.
This will also enforce the need for unreleased changes part of the PR itself and will fail otherwise.
Manual workflow involves:
changie newto create a new fragment that represent the changes introduced by a PRchangie batch autoto prepare a new release and version it automatically based on the unreleased changes (see.changie.yamlfor which kind of changes will bump different versions)changie mergeto consolidate the new release along the previous ones and updateshard.ymlwith the new version information.TODO:
shard.ymlwhen batching a new release