Adds changelog validation to release workflow #24
Conversation
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.
TLDR;
Adds a validation step to the release workflow that checks if all packages have a changelog entry for the current release version.
What Does This Do?
This change introduces a new job in the
publish-release.ymlworkflow that validates the existence of changelog entries for each package being released. This helps ensure that each release includes proper documentation in the changelog files.Brief Details?
The new job iterates through a list of packages, checks for the existence of a
CHANGELOG.mdfile in each package's directory, and verifies that the file contains an entry for the current release version. The script usesgrepto check for a header matching the version number. If a changelog file is missing or an entry for the current version is not found, an error message is displayed, and the workflow exits.How Do The Tests Prove The Change Works?
The workflow will fail if any package is missing a
CHANGELOG.mdfile or if a changelog entry for the current release version is not found. This prevents releases from being published without proper documentation.