Add contributor credits to release skills (#319 )

Release changelogs now credit contributors inline (Bun-style):
- Per-entry "thanks @user!" for community code contributions
- Per-entry "thanks @user for the report!" for bug reporters
- "Thanks to N contributors!" summary section at bottom of each release
- Core team (lawrencecchen, austinywang) excluded from per-entry callouts

2026-02-22 16:18:44 -08:00

4.3 KiB

Raw Blame History

Release Nightly

End-to-end release via PR flow: bump version, update changelog, create PR, merge, tag, then build locally via scripts/build-sign-upload.sh.

Steps

Phase 1: Version bump, changelog, PR, merge, tag

Determine the new version number
- Get the current version from GhosttyTabs.xcodeproj/project.pbxproj (look for MARKETING_VERSION)
- Bump the minor version unless the user specifies otherwise (e.g., 0.48.0 → 0.49.0)
Create a release branch
- Create branch: git checkout -b release/vX.Y.Z
Gather changes and contributors since the last release
- Find the most recent git tag: git describe --tags --abbrev=0
- Get commits since that tag: git log --oneline <last-tag>..HEAD --no-merges
- Filter for end-user visible changes only - ignore developer tooling, CI, docs, tests
- Categorize changes into: Added, Changed, Fixed, Removed
- Collect contributors: For each PR referenced in the commits, get the author:
```
gh pr view <N> --repo manaflow-ai/cmux --json author --jq '.author.login'
```
- Also check for linked issue reporters (the person who filed the bug):
```
gh issue view <N> --repo manaflow-ai/cmux --json author --jq '.author.login'
```
- Build a deduplicated list of all contributor @handles for the release
Update the changelog
- Add a new section at the top of CHANGELOG.md with the new version and today's date
- Only include changes that affect the end-user experience
- Write clear, user-facing descriptions (not raw commit messages)
- Credit contributors inline (see Contributor Credits below)
- Also update docs-site/content/docs/changelog.mdx if it exists
- If there are no user-facing changes, ask the user if they still want to release
Bump the version
- Run ./scripts/bump-version.sh (bumps minor by default)
Commit and push the release branch
- Stage: CHANGELOG.md, GhosttyTabs.xcodeproj/project.pbxproj
- Commit message: Bump version to X.Y.Z
- Push: git push -u origin release/vX.Y.Z
Create PR and wait for CI
- gh pr create --title "Release vX.Y.Z" --body "...changelog..."
- gh pr checks --watch
Merge PR
- gh pr merge --squash --delete-branch
- git checkout main && git pull
Create and push the tag
- git tag vX.Y.Z && git push origin vX.Y.Z

Phase 2: Local build, sign, notarize, upload

Run the build script

./scripts/build-sign-upload.sh vX.Y.Z

This script handles: GhosttyKit build, xcodebuild, Sparkle key injection, codesigning, notarization (app + DMG), appcast generation, GitHub release upload, and cleanup.

If the script fails, run say "cmux release failed".

Changelog Guidelines

Include only end-user visible changes:

New features users can see or interact with
Bug fixes users would notice (crashes, UI glitches, incorrect behavior)
Performance improvements users would feel
UI/UX changes
Breaking changes or removed features

Exclude internal/developer changes:

Setup scripts, build scripts, reload scripts
CI/workflow changes
Documentation updates (README, CONTRIBUTING, CLAUDE.md)
Test additions or fixes
Internal refactoring with no user-visible effect
Dependency updates (unless they fix a user-facing bug)

Contributor Credits

Credit the people who made each release happen. This builds community and encourages contributions.

Per-entry attribution — append contributor credit after each changelog bullet:

For code contributions (PR author): — thanks @user!
For bug reports (issue reporter, if different from PR author): — thanks @reporter for the report!
Core team (lawrencecchen, austinywang) contributions get no per-entry callout — core work is the baseline

Summary section — add a "Thanks to N contributors!" section at the bottom of each release:

### Thanks to N contributors!

- [@user1](https://github.com/user1)
- [@user2](https://github.com/user2)

List all contributors alphabetically by GitHub handle (including core team)
Link each handle to their GitHub profile
Include everyone: PR authors, issue reporters, anyone whose work is in the release

GitHub Release body — when the release is published, the GitHub Release should also include the "Thanks to N contributors!" section with linked handles.

4.3 KiB Raw Blame History