Add a CHANGELOG, pin the install URL to the tag, drop lint.yml#40
Merged
Conversation
|
Important Review skippedAuto reviews are disabled on base/target branches other than the default branch. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Plus Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
✨ 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 |
**#30** — a first stable tag is where users and packagers start needing a record of what the tool is and what its rough edges are. `CHANGELOG.md` follows Keep a Changelog with a `## [1.0.0]` section. For a first release it describes the tool rather than a diff: the five subcommands, the container layout, the four env vars, the corrected bash requirement, the behavior worth knowing (that `add` writes to the remote, and that `clean` is absent), every fix that landed in this batch, and the known limitations. **Curl URL** now points at `v1.0.0` instead of `main`, with a note that `main` is a moving target. This lands last on purpose: the README URL 404s in the window between merging this and cutting the tag, so the two should happen together. **#33** — `lint.yml` was a three-line comment-only file at the repo root explaining that linting moved to `.github/workflows/ci.yml`. GitHub never ran it, and it would have shipped inside the tag as a note to maintainers about a refactor that already happened. Removed; the commit that moved the workflow is the durable record. Closes #30, closes #33. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
1.0.0 is the first release, so an entry explaining that `clean` existed and was pulled refers to a version nobody ran. State the property instead — nothing here deletes — and drop the now-orphaned [#17] and [#34] link definitions. The "branch names may not contain /" entry is also no longer true: branches with slashes are supported and slug to `-` in the directory name. Restated, including the feature/x vs feature-x collision that falls out of it. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
A first release should list shipped features with PR links, not Keep a Changelog archaeology that implies a prior version. Co-authored-by: Cursor <cursoragent@cursor.com>
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.
Merge order: 6 of 6, into
v1.0.0-integration— merge last, so the pinnedcurl URL lands immediately before the tag.
Closes #30, closes #33.
#30 — CHANGELOG and release notes
CHANGELOG.mdin Keep a Changelog form with a## [1.0.0]section. For a first release it describes the tool rather than adiff:
init,root,add,track,list/lsTREES_NO_PUSHsh; macOS 3.2 is fine)addwrites to the remote by default, andthat
cleanis absent with the by-hand equivalentcleansubcommand from v1.0.0 #35–CI: test the failure modes, not just the happy paths #39, called out by behavior change, with issue linksCurl URL pinned to
v1.0.0Deliberately last: the README URL 404s in the window between this merging and
the tag existing, so the two should happen back to back.
#33 —
lint.ymlA three-line comment-only file at the repo root saying linting moved to
.github/workflows/ci.yml. GitHub never ran it — it isn't in.github/workflows/— and it is tracked, so it would have shipped inside the tagas a note to maintainers about a refactor that already happened. The commit that
moved the workflow is the durable record.
grep -rn 'lint\.yml'now returns only the CHANGELOG entry recording theremoval.
Scope notes
git trees version/--version#28 (git trees version/--version) is explicitly out of scope andstays open, so Add a CHANGELOG and v1.0.0 release notes #30's "
VERSIONmatches the tag" checklist item is dropped andthe gap is instead recorded under Known limitations. Pinning the curl URL is
what makes an install identifiable without it.
issues/review packet" item is already satisfied— no such directory exists in the tree.
Release checklist
cleansubcommand from v1.0.0 #35, Fix five defects ingit-trees#36, Document thataddwrites to the remote, and add--no-push#37, Docs: a quickstart that works, a concepts primer, and honest install docs #38, CI: test the failure modes, not just the happy paths #39 merged intov1.0.0-integration, CI green onubuntu + macOS
git statusworksv1.0.0-integrationmerged tomain; tag points atmainand is theintended tip
Then, to publish — this extraction command is verified against the file as
committed (
sed -n '/## 1.0.0/,/## 0/p'from #30 does not terminate, sincethere is no earlier version section):
I have not cut the tag or created the release — that is outward-facing and
yours to run.
🤖 Generated with Claude Code