feat: add GitHub release workflow and documentation#15
Merged
Conversation
- Add .github/workflows/release.yml triggered on tag push - Validates tag matches VERSION file - Extracts release notes from ChangeLog - Creates GitHub Release automatically - Add RELEASING.md with step-by-step release process Co-authored-by: Brian Thompson <brianrobt@users.noreply.github.com>
- Remove Unreleased section from ChangeLog (per new release process) - Convert pending fix (#8) to versioned 1.2.1 entry - Bump VERSION to 1.2.1 - Add reference to RELEASING.md in ChangeLog header Co-authored-by: Brian Thompson <brianrobt@users.noreply.github.com>
|
Caution Review failedThe pull request is closed. ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (9)
📝 WalkthroughWalkthroughThe release process now publishes GitHub Releases from versioned tags, documents release procedures, and updates version metadata. CI compares installed versions directly, while terminal display functions use ANSI coloring for supported terminals. ChangesRelease process
Terminal output coloring
Estimated code review effort: 3 (Moderate) | ~20 minutes Sequence Diagram(s)sequenceDiagram
participant GitTag as Git tag push
participant ReleaseWorkflow as Release workflow
participant VERSION
participant ChangeLog
participant GitHubRelease as GitHub Release
GitTag->>ReleaseWorkflow: Push v* tag
ReleaseWorkflow->>VERSION: Validate tag version
ReleaseWorkflow->>ChangeLog: Extract release notes
ReleaseWorkflow->>GitHubRelease: Create release and set prerelease flag
Possibly related PRs
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
… bash Replace custom awk script with ffurrer2/extract-release-notes@v2 action for parsing Keep a Changelog format. Co-authored-by: Brian Thompson <brianrobt@users.noreply.github.com>
Co-authored-by: Brian Thompson <brianrobt@users.noreply.github.com>
tput sgr0 on macOS outputs \033(B\033[m which includes a 'switch to ASCII character set' sequence. GitHub Actions logs don't handle this properly, causing '(B' characters to appear in output. Using direct ANSI escape codes (\033[0;XXm) avoids this issue and is more portable. Also added xterm-256color to TERM checks. Co-authored-by: Brian Thompson <brianrobt@users.noreply.github.com>
brianrobt
marked this pull request as ready for review
July 19, 2026 12:52
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
Establishes a formal release process for gvm2 with GitHub Releases integration.
Changes
Release Workflow (
.github/workflows/release.yml)v*)VERSIONfileffurrer2/extract-release-notes@v2to parse theChangeLog(Keep a Changelog format)softprops/action-gh-release@v2-rc,-beta,-alpha) appropriatelyDocumentation (
RELEASING.md)ChangeLog Updates
[Unreleased]section in favor of release-driven changelog entriesRELEASING.md1.2.1entryVersion Bump
VERSIONto1.2.1in preparation for the next releaseRelease Process Going Forward
VERSIONfilechore: release vX.Y.Zgit tag vX.Y.Z && git push origin vX.Y.ZNote on v1.2.0
The v1.2.0 release was documented in
ChangeLogbut never tagged. Consider retroactively tagging commit42f3656asv1.2.0to maintain release history:Summary by CodeRabbit
New Features
Bug Fixes
Documentation
Chores