mcpField
G
github-release-best-practices

github-release-best-practices

github.com/d-o-hubDevelopment1337 installsUpdated today
Repository

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

  1. 01Describe the `Cargo.toml` version update
  2. 02Specify changelog version-header format
  3. 03List roadmap and status updates before release
  4. 04Give the release command and notes check
  5. 05Explain Semver bumps and changelog categories

Use cases

  1. 01Prepare release changes before merging
  2. 02Ship through the prescribed script
  3. 03Check GitHub Release notes content
  4. 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-practices

After installing, type/github-release-best-practicesin Claude Code to confirm it loaded.

Bundled filesevals/evals.json

Details

From the project README

GitHub 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)

  1. Bump workspace version in root Cargo.toml (all members follow workspace).
  2. Update CHANGELOG.md with exactly one ## [X.Y.Z] - YYYY-MM-DD (unique version headers — cargo-dist/parse-changelog fails silently on duplicates → empty GitHub Release body).
  3. Set Released Version in plans/ROADMAPS/ROADMAP_ACTIVE.md and plans/STATUS/CURRENT.md to vX.Y.Z.
  4. Merge PR; wait for main CI green.
  5. Run: ./scripts/release-manager.sh ship --execute
  6. Confirm notes: gh release view vX.Y.Z shows ## Release Notes content (v0.1.34/v0.1.35 format).

Semver (0.x)

ChangeBump
Breakingminor or major (team call)
Featureminor preferred
Fixpatch

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