Add acknowledgement message for releases with no changelog entries #50
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
In the event that no changelog entries are found for a release, we add a line acknowledging this, so that there is content associated with the changelog header for this version. This phenomenon can happen since a release may be made that consists of commits that are not included as changelog entries, like `build`, `chore`, or `docs`. Previously, the release process would abort if there were no changelog entries. This change allows us to still update the changelog with the version release when only internal/documentation commits make up the release.
Since a changelog will always be created even when no applicable changelog entries are generated, the bullet point for this scenario can be removed.
|
@yokuze @joshuacurtiss is this still a thing we want to land? |
|
|
@onebytegone this seems reasonable to me. Thoughts? |
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.
By detecting if the changelog content is empty, the release script would return
undefinedwhich then caused the release to abort. We just change the logic to instead insert a line that indicates, "This release only contains documentation or internal changes." That prevents the release from aborting and provides a meaningful comment to fill the void of any otherwise empty space where the changelog entries would appear.As explained in #49, this enables us to still add releases to the changelog even when all the changes are internal/documentation.