chore: link CHANGELOG from npm + README, add release skill - #188
Merged
Peter Hauge (petehauge) merged 3 commits intoJun 25, 2026
Merged
Peter Hauge (petehauge) merged 3 commits into
Peter Hauge (petehauge) merged 3 commits into
Conversation
- package.json: bundle CHANGELOG.md in published files and add a `changelog` link field so the npm registry surfaces it. - README.md: add a Changelog section linking CHANGELOG.md and the GitHub compare view so users can see what changed since their installed version. - .squad/skills/release-apiops-version: new skill documenting the end-to-end release process (clean-tree check, branch, changelog authoring, `npm version` cheat sheet, PR creation). Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
The repo's established convention is .copilot/skills/ for project skills (32 of them); .squad/skills/ has only task-tracking. Move the new skill to match the dominant pattern so Copilot CLI sessions discover it. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
- CHANGELOG.md: real 0.3.0-alpha.0 entry covering all 11 user-facing PRs merged since 0.2.1-alpha.0 (Breaking Changes, Features, Bug Fixes, Docs & Testing). Includes the compare-link footer entry so the heading renders as a clickable diff like every prior version. - release-apiops-version skill: rewrite Step 4 to enumerate PRs via `gh pr list --search "merged:>=<date>"` instead of trusting `git log tag..tag` (tags in this repo have been placed prematurely in the past and aren't a reliable boundary). Step 6 now requires the compare-link footer entry and verifies both the heading and the footer link. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Elizabeth Maher (EMaher)
approved these changes
Jun 25, 2026
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
2 participants
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
Improves changelog discoverability for users on older versions of
@peterhauge/apiops-cliand codifies the release process as a Squad skill.Changes
package.jsonCHANGELOG.mdto thefilesarray so it ships inside the published npm tarball (the npm registry surfaces a bundledCHANGELOG.mdon the package page)."changelog"field pointing atCHANGELOG.mdonmain. This is the convention used by a number of registries/tools to link directly to release notes.README.mdCHANGELOG.mdand to a GitHub compare URL (v0.2.1-alpha.0...main) so a user on a known installed version can see exactly what's been merged since..squad/skills/release-apiops-version/SKILL.md(new)End-to-end checklist for cutting a new release:
mainand fast-forward pull.release/v<NEW_VERSION>branch.git log/gh pr listsince the last tag.ask_user.## [VERSION] — YYYY-MM-DDsection inCHANGELOG.mdmatching the format the release workflow greps for.npm version ... --no-git-tag-version(includes a cheat sheet coveringprerelease,patch,preminor,premajor, and explicit version forms with the--preid=alphaflag)..github/workflows/squad-release.ymlhandles tagging and the GitHub Release.Why
0.2.1-alpha.0has no good way to tell how farmainhas advanced without cloning the repo.CHANGELOG.md+ linking it frompackage.jsonand the README means the answer is one click away from the npm page or the repo root.squad-release.ymlchangelog validator.Related
Follow-up to discussion about release highlights / versioning process (no linked issue).
Test plan
package.jsonparses (node -p "require('./package.json').version"still works).