Skip to content

docs: add Publishing section to README #106

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
github-actions wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

docs: add Publishing section to README #106

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 38 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -123,6 +123,44 @@ catalog/
`.lock.yml` files are marked `linguist-generated` and `merge=ours` in `.gitattributes` to prevent spurious merge conflicts.
</details>

## Publishing

> Maintainers only. Follow these steps when cutting a new release.

### 1. Bump the version

Update the `version` field in `.claude-plugin/plugin.json`:

```json
{
"version": "0.X.Y"
}
```

Use semantic versioning: bump `patch` for fixes and documentation, `minor` for new skills or catalog entries, `major` for breaking changes to the plugin manifest or skill interface.

### 2. Commit and tag

```bash
git add .claude-plugin/plugin.json
git commit -m "chore: bump to v0.X.Y"
git tag v0.X.Y
git push origin main --tags
```

### 3. Create a GitHub Release

Go to [Releases](https://github.com/verkyyi/github-agent-runner/releases/new) and create a release from the tag. Include a changelog entry summarizing what changed.

### 4. Update registry listings

The plugin is listed on two community registries. Update each after the GitHub Release is published:

- **[claude-plugins.dev](https://claude-plugins.dev)** — follow the submission process linked on the site.
- **[ClaudePluginHub](https://claudepluginhub.com)** — update the listing with the new version and changelog.

The self-hosted marketplace at `.claude-plugin/marketplace.json` points to the repository URL and picks up the latest version automatically — no manual update required.

## Credits

Built on two open-source projects from the [GitHub Next](https://githubnext.com) team:
Expand Down