About github-release-best-practices
github-release-best-practices is a reference for maintainers following this repository's GitHub release process. It covers pre-release version and changelog updates, the prescribed release command, and checks for the resulting release notes.
Key features
- 01Describe the `Cargo.toml` version update
- 02Specify changelog version-header format
- 03List roadmap and status updates before release
- 04Give the release command and notes check
- 05Explain Semver bumps and changelog categories
Use cases
- 01Prepare release changes before merging
- 02Ship through the prescribed script
- 03Check GitHub Release notes content
- 04Choose a version bump for a fix or feature
Install
Copy the command and run it in a terminal.
$
npx skills add https:/ / github.com/ d-o-hub/ rust-self-learning-memory --skill github-release-best-practicesAfter installing, type/github-release-best-practicesin Claude Code to confirm it loaded.
Bundled filesevals/evals.json
Details
From the project READMEGitHub Release Best Practices (reference only)
Canonical procedure: release-guard
Canonical CLI:./scripts/release-manager.sh ship --execute
GitHub Release creator:.github/workflows/release.yml(tag push only)
Do not invent a second release path. This file is supporting context only.
Prep before ship (via PR to main)
- Bump workspace
versionin rootCargo.toml(all members follow workspace). - Update
CHANGELOG.mdwith exactly one## [X.Y.Z] - YYYY-MM-DD(unique version headers — cargo-dist/parse-changelog fails silently on duplicates → empty GitHub Release body). - Set Released Version in
plans/ROADMAPS/ROADMAP_ACTIVE.mdandplans/STATUS/CURRENT.mdtovX.Y.Z. - Merge PR; wait for main CI green.
- Run:
./scripts/release-manager.sh ship --execute - Confirm notes:
gh release view vX.Y.Zshows## Release Notescontent (v0.1.34/v0.1.35 format).
Semver (0.x)
| Change | Bump |
|---|---|
| Breaking | minor or major (team call) |
| Feature | minor preferred |
| Fix | patch |
Changelog categories
Added · Changed · Deprecated · Removed · Fixed · Security
Forbidden
# DO NOT — bypasses cargo-dist and release.yml preflight
gh release create vX.Y.Z ...
References
- ADR-034 Release Engineering
.agents/skills/release-guard/SKILL.md./scripts/release-manager.sh
Comments
Markdown supported