Skip to content

Add automated release tooling#70

Merged
kyamagu merged 4 commits intomainfrom
feature/release-automation
Apr 14, 2026
Merged

Add automated release tooling#70
kyamagu merged 4 commits intomainfrom
feature/release-automation

Conversation

@kyamagu
Copy link
Copy Markdown
Collaborator

@kyamagu kyamagu commented Apr 14, 2026

Summary

  • Add scripts/release.sh to automate the release preparation workflow (create branch, bump version, update CHANGELOG, open PR)
  • Add .github/workflows/auto-release.yaml to automatically create the git tag and GitHub Release when a release/v* branch is merged to main
  • Add /release Claude Code skill (.claude/commands/release.md) for AI-assisted release orchestration
  • Update CLAUDE.md and CONTRIBUTING.md release docs to reflect the new workflow

Fixes included

  • release.sh now fails early if the [Unreleased] CHANGELOG section is empty (matches documented behaviour)
  • CHANGELOG.md: add [Unreleased] section with entry for this PR
  • .markdownlint.json: enable allow_different_nesting so repeated sub-headings across CHANGELOG versions don't trigger MD024 warnings

Test plan

  • Review scripts/release.sh logic (precondition checks, version bump, CHANGELOG update, PR creation)
  • Review .github/workflows/auto-release.yaml (trigger condition, tag creation, release notes extraction)
  • Verify release.sh exits non-zero when [Unreleased] section is empty
  • Confirm markdownlint no longer warns on CHANGELOG

🤖 Generated with Claude Code

kyamagu and others added 3 commits April 14, 2026 12:01
- scripts/release.sh: one-command script that creates the release branch,
  bumps version, updates CHANGELOG, runs uv sync, and opens a PR
- .github/workflows/auto-release.yaml: post-merge workflow that creates
  the git tag and GitHub Release when a release/v* branch is merged,
  triggering the existing wheel build and PyPI publish pipeline
- CHANGELOG.md: restore [Unreleased] sentinel heading
- CLAUDE.md, CONTRIBUTING.md: simplify release process docs to 3 steps

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
- Add .claude/commands/release.md: slash command that infers the next
  semver bump from [Unreleased] headings, confirms with the user, runs
  scripts/release.sh, and summarises post-merge steps including the
  GitHub Actions manual approval gate
- Reframe CLAUDE.md release section so [Unreleased] is described as an
  ongoing per-PR responsibility, consistent with CONTRIBUTING.md and
  the PR template checklist

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
…lint config

- release.sh now refuses to proceed if [Unreleased] section is empty,
  matching the behaviour described in docs
- Add CHANGELOG entry for the release automation tooling (#68)
- Enable MD024 allow_different_nesting so repeated sub-headings across
  CHANGELOG versions don't trigger markdownlint warnings

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Copilot AI review requested due to automatic review settings April 14, 2026 03:26
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds automated tooling and documentation for a PR-based release workflow, including a maintainer script and a GitHub Actions workflow that creates tags/GitHub Releases when release/v* branches are merged to main.

Changes:

  • Add scripts/release.sh to create release/vX.Y.Z branches, bump version, update CHANGELOG.md, and open a release PR.
  • Add .github/workflows/auto-release.yaml to tag and create a GitHub Release after a release PR merge.
  • Update release documentation and changelog/lint configuration to support the new workflow.

Reviewed changes

Copilot reviewed 7 out of 7 changed files in this pull request and generated 5 comments.

Show a summary per file
File Description
scripts/release.sh New release preparation script (branching, version bump, changelog move, lock update, PR creation).
.github/workflows/auto-release.yaml New workflow to create a git tag and GitHub Release when a release/v* PR is merged.
.claude/commands/release.md New Claude command to guide/execute the release workflow.
CONTRIBUTING.md Updated maintainer-facing release instructions to use the new automation.
CLAUDE.md Updated release process documentation to match the automated workflow.
CHANGELOG.md Adds [Unreleased] section with entry describing this PR.
.markdownlint.json Adjust markdownlint settings to avoid MD024 warnings in changelog structure.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread scripts/release.sh Outdated
Comment thread scripts/release.sh Outdated
Comment thread .claude/commands/release.md Outdated
Comment thread .claude/commands/release.md Outdated
Comment thread .claude/commands/release.md Outdated
- release.sh: add |\Z to both regex lookaheads so they handle
  [Unreleased] being the last section in CHANGELOG.md
- release.md: align empty-section description with script behaviour
  (non-whitespace content, not bullet points specifically)
- release.md: allow both vX.Y.Z and X.Y.Z as valid version arguments
- release.md: fix branch name in remediation hint to use release/v<VERSION>

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@kyamagu kyamagu merged commit cd7b6d9 into main Apr 14, 2026
4 checks passed
@kyamagu kyamagu deleted the feature/release-automation branch April 14, 2026 03:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants