Add release notes + CI test workflow - #21
Merged
Merged
Conversation
Release notes now live in NOTES.md, shipped as a release asset alongside cmux.sh and VERSION, and sectioned by "## X.Y.Z". On the first cmux invocation after an update, the current version's section is printed as a banner; "cmux version" also prints it. Users on a fresh install or upgrading into this feature stay silent on their first run (no seen-version file yet) to avoid a surprise blast. Also adds tests/ with a simple runner (tests/run.sh) and a first test file covering the new behavior, including the missing-NOTES.md degradation paths. Run with: bash tests/run.sh Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Adds a Tests workflow that runs tests/run.sh on pull_request and on push to main, across ubuntu-latest and macos-latest. macOS coverage matters because /bin/bash there is 3.2 (Apple ships the old one for licensing reasons), which has already bitten this repo at least once. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Owner
Author
|
Quick context: I view this release notes system as a required dependency for the upcoming project name change. we need some way to educate folks on the new command name as part of the transition. plus this is just a nice lil' feature |
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.
Summary
NOTES.md(sectioned by## X.Y.Z) ships as a release asset andcmuxshows the current version's section once after an update, plus viacmux versiontests/directory with a simple runner and first test file covering the new behaviorubuntu-latestandmacos-latest(bash 3.2 coverage)How the feature behaves
cmux update: the nextcmux <cmd>prints acmux X.Y.Z — what's new:banner once, then updates the seen file.cmux version: always prints version + current section's notes.NOTES.mdmissing / section missing: degrades silently,cmux versionstill prints the version string.Release notes are kept out of
cmux.shso cutting a release only requires editingNOTES.md+ bumpingVERSION.Test plan
bash tests/run.shpasses locally under bash 5 and/bin/bash(3.2) on macOS — 14 tests across: section extraction, missing-file degradation, seen-file state machine,cmux versionoutput0.1.3 → 0.1.4update shows the banner once, subsequent runs silentNotes for the reviewer
VERSIONstays at0.1.3in the tree; bump to0.1.4at release time —NOTES.mdalready has the## 0.1.4section staged🤖 Generated with Claude Code