Update Release Workflow and README Banners#128
Merged
Conversation
- Pass github.repository as an environment variable to the release notes generation step to avoid YAML parsing errors with HEREDOC. - Use the new environment variable consistently for all repository URLs within the script for improved robustness.
This commit introduces two main improvements:
1. **Release Workflow:** The GitHub Actions workflow for creating
releases has been updated to automatically generate a changelog
based on commit history since the last tag. The release description
is now managed via a HEREDOC, making it much easier for humans to
edit. The workflow syntax has also been corrected for robustness.
2. **README Banners:** The shield.io banner icons in the `README.md`
are now linkable, pointing to their respective pages on GitHub
(e.g., Releases, Issues, etc.).
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
1 participant
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 updates the release workflow to include an automatic changelog and makes the banner icons in the README linkable.