proofgeist/create-changeset

Create Changeset Skill

Purpose

This skill automatically analyzes branch changes and creates appropriate changesets for package releases in this monorepo. It examines git history, determines version bump types based on Conventional Commits, and generates properly formatted changeset files.

When to Invoke

Automatically invoke this skill when:

• User is preparing to create a pull request
• User mentions "PR", "pull request", or "ready for review"
• Branch has commits ready for review
• User explicitly mentions "changeset" or "version bump"

Do NOT invoke when:

• User is only pushing changes without creating a PR
• Only documentation files have changed (README, .md files)
• Only CI/CD configuration has changed (.github/workflows/)
• Only development tool configuration has changed (eslint, prettier, etc.)
• Commits are only docs:, chore:, ci:, or test: types that don't affect packages

Pre-execution Validation

Before creating a changeset, check if a changeset file already exists for the current changes:

• Look for .changeset/*.md files (excluding README.md)
• If exists, ask user: "A changeset already exists. Create another one?"

Implementation Steps

1. Check Current State

Execute git log main..HEAD (or origin/main..HEAD) to check for committed changes on the branch. If no commits exist, exit early without creating a changeset.

2. Analyze Changes

Use git diff main...HEAD (or origin/main...HEAD) to analyze committed changes only.

Identify which packages are affected by checking files under packages/*/. Review commit messages using git log main..HEAD --oneline (or origin/main..HEAD).

3. Determine Version Bump Type

Analyze commit messages following Conventional Commits 1.0.0 format:

• major: Contains BREAKING CHANGE in commit body, or breaking changes detected in code
  • API signature changes
  • Removed exports or features
  • Incompatible behavior changes
• minor: Starts with feat: or feat(scope): - new features (backward compatible)
  • New components or functionality
  • New props or options (with defaults)
  • New exports
• patch: Starts with fix: or fix(scope): - bug fixes and minor improvements
  • Bug fixes
  • Performance improvements
  • Minor style updates
• skip: Other types (chore:, docs:, ci:, test:) typically don't require changesets unless they affect package functionality

Review actual code changes to confirm the appropriate version bump. When in doubt between minor and patch, prefer patch for safety.

If the version bump is ambiguous or unclear:

• Ask user for clarification
• Explain the reasoning behind the suggested bump type
• Allow user to override the suggestion

If all commits are types that don't require changesets (docs:, chore:, ci:, test:), exit early without creating a changeset.

4. Generate Changeset

Create a changeset file with a descriptive filename in .changeset/ directory.

Filename format:

• Use kebab-case with .md extension
• Examples: .changeset/add-new-button.md, .changeset/fix-layout-bug.md, .changeset/update-icon-props.md

File content format:

---
"@proofkit/package-name": major|minor|patch
---

Clear description of the change

Example for single package:

---
"@proofkit/cli": minor
---

Add new Button variant for secondary actions

Example for multiple packages:

---
"@proofkit/cli": minor
"@proofkit/typegen": patch
---

- @proofkit/cli: Add new Button variant for secondary actions
- @proofkit/typegen: Fix color token contrast ratio

Important guidelines:

• The description should be user-friendly as it will appear in CHANGELOG
• Use the same language as the commit messages (Japanese or English). If commit messages are mixed, prefer Japanese.
• Split changesets into separate files when the same package has changes with different purposes (e.g., new feature + bug fix, breaking change + internal refactoring)
• This creates individual top-level items in release notes, making it easier for readers to understand the intent of each change
• Example: Create .changeset/add-secondary-button.md for a new feature and .changeset/fix-button-layout.md for a bug fix, even if both target the same package

5. Lint Changeset

Execute pnpm textlint .changeset/<filename>.md to validate the changeset file.

Error handling:

• If linting errors occur, attempt to auto-fix common issues:
  • Spacing and punctuation
  • Common grammar mistakes
• Re-run textlint after auto-fix
• If errors persist:
  • Display error details to user
  • Ask user for guidance on how to fix
  • Do NOT proceed to commit until lint passes

6. Verify and Commit

Display the generated changeset for review:

• Show the file path
• Show the file content
• Confirm it accurately reflects the changes

Once verified, commit the changeset file:

git add .changeset/<filename>.md
git commit -m "chore: add changeset"