You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
chore: include CHANGELOG.md in published npm tarball #1171
The published @bradygaster/squad-cli npm tarball does not contain a CHANGELOG.md. The GitHub repo has one, but consumers of the npm package — including offline tooling, post-upgrade "what's new" prompts, and editor extensions — cannot show release notes without a network call to GitHub.
Proposal
Include CHANGELOG.md in the published npm tarball.
How:
Add CHANGELOG.md to the files field in packages/squad-cli/package.json (or the .npmignore allowlist)
Ensure release tooling stamps it into the published artifact
Why
Offline-friendly:squad upgrade can show what's-new without internet
No gh dependency: Tooling does not need GitHub Releases API + auth to show release notes
Ecosystem convention: Most CLIs ship a CHANGELOG with their package (Keep a Changelog format)
Enables downstream features: Downstream tamirdresher_microsoft/squad-squad#1 needs a what's-new digest. With a local CHANGELOG, that digest works offline.
Acceptance
CHANGELOG.md present in published npm tarball (verify with npm pack or npm view ... --json)
Format follows Keep a Changelog so consumers can programmatically diff between versions
Release tooling keeps the changelog in sync
Context
Filed during architecture review for downstream tamirdresher_microsoft/squad-squad#1. Companion to:
Activity
chore: include CHANGELOG.md in published npm tarball (github#1257)
chore: promote v0.10.1 dev → main + v0.10 stabilisation blog post (#1313
chore: promote dev → main (v0.11.0) (#1422)