Repository navigation
Changelog: Never create a release when create-release is disabled - #1547
Merged
Merged
Conversation
This branch was previously deployed
This file contains hidden or 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.
Summary
With
create-release: false, the changelog module never creates a release.Context
Only the tag creation event was guarded by the
create-releaseoption. The changelog generation flow (triggered by therelease,pull_request,milestoneanddiscussionevents) called_create_releaseunconditionally when no release existed for the tag, or when the release was deleted between the get and the update. For example, editing a milestoned closed pull request of a tag without a release created one even withcreate-release: false.Implementation Details
Changelog.processreadscreate-release(defaultconfiguration.CREATE_RELEASE_DEFAULT) in the changelog generation path and skips the release creation, with a log, when the option is disabled.Impact/Risks
create-release: falseare affected: they stop getting unexpected releases.