ci: add CHANGELOG and prefer it for GitHub release notes - #4
Merged
Conversation
- Created a new CHANGELOG.md file to track notable changes and adhere to Semantic Versioning. - Documented the features and changes introduced in version 1.1.0, including the optional HTTP execution for registered backends and related environment variables. - Updated README.md to reference the new CHANGELOG for release history.
- Updated the publish workflow to improve release notes handling by extracting sections from CHANGELOG.md based on the current version. - Implemented logic to generate release notes from the previous tag if no CHANGELOG section exists. - Enhanced initial release handling to create a stub when no prior tags are found.
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.
Description
Adds a Keep a Changelog–style
CHANGELOG.mdfor release history and updates the publish workflow so GitHub Release notes prefer the matching version section from that file. When no section exists, the workflow falls back togh --generate-notesfrom the previousv*tag, or an initial-release stub when none is found. The README now points readers at the changelog and this release-notes behavior.Key Changes & Features Implemented
Documentation
CHANGELOG.mddocumenting 1.0.0 and 1.1.0 (opt-incall_endpoint, related env vars, and supporting changes) (ddc9929)ddc9929)CI / Release Publishing
## [version]fromCHANGELOG.mdfor release notes before creating the GitHub Release (21be580)gh release create --generate-notessince the previousv*tag when no changelog section exists (21be580)v*tag (21be580)How to Test
CHANGELOG.mdincludes a## [1.1.0]section and that README links to it..github/workflows/publish.ymlrelease-notes step: with a matching changelog section, notes should come from that section.1.1.0(no product code changes in this PR).