agentleFS
ClickHouseClickHouse/clickhouse-connect/.claude/skills/release-prep/SKILL.md

release-prep

Skill536 starsChanged 4 days agoApache-2.0View on GitHub

Prepare a release by creating a release branch, updating the changelog, and bumping the version number. Use when the user wants to cut a new release.

  • Installs packages

25 other projects use a version of this.

Adopted by

Most recently taken up by

The file

We split this skill into the rules it gives an agent

2 rules. 0 are common, 2 are distinctive, and 0 are very specific to this project.

  • 0

    Common

    Most of the 23 edited versions we read keep these.

  • 2

    Distinctive

    This author's own choices. Worth a look.

  • 0

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    After making the changes, show the user a short summary of what was done:

    line 62
  2. Distinctive:

    Do NOT commit the changes.

    line 68

“Common” is measured: kept by at least 6 in 10 of the 23 edited versions of this file we could read. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

Release Prep

Prepare a release for version $ARGUMENTS.

Steps

1. Validate the version argument

The user must supply a version number (e.g. 0.14.0). If $ARGUMENTS is empty or missing, ask the user to provide a version number and stop.

2. Ensure you are on the correct release branch

First, switch to main and run git pull to ensure you have the latest changes. Then, if you are NOT already on release/$ARGUMENTS, create the branch release/$ARGUMENTS from main and switch to it. If the branch already exists remotely or locally, switch to it instead of creating a new one.

3. Update the changelog

Open CHANGELOG.md and find the ## UNRELEASED section. Rename it to ## $ARGUMENTS, <today's date in YYYY-MM-DD format>. Then insert a new empty ## UNRELEASED heading immediately above the newly renamed section, with a blank line separating them.

The result should look like:

## UNRELEASED

## $ARGUMENTS, YYYY-MM-DD

### Breaking Changes
...

4. Update the version file

Open clickhouse_connect/_version.py and update the version string to "$ARGUMENTS".

5. Generate release notes

Draft GitHub release notes for this release and print them to the console (do NOT publish them, do NOT write them to a file). The user will copy/edit them when they cut the GitHub release.

Tailor the notes to the kind of release this actually is — do not force a one-size-fits-all template. Use the version number and the CHANGELOG entries (the section you just renamed) to decide:

  • Patch / bug-fix release (e.g. 1.0.1): short. A one-paragraph "what this fixes" intro, then a ## What's Changed section with a ### Bug Fixes list. Link issue/PR numbers where the CHANGELOG mentions them. No migration section needed.
  • Minor release (e.g. 1.1.0): "Highlights" section grouping notable changes (Performance / Features / Bug fixes / Other), then a brief installation block. Include a migration note only if there is genuinely user-visible behavior change.
  • Major release (e.g. 2.0.0): full structure — intro, upgrading section pointing to MIGRATION.md if it exists, Highlights grouped by theme, and a list of any prior RC tags if applicable.
  • Release candidate / pre-release (e.g. 1.0.0rc1, 1.1.0a1): lead with a "this is a release candidate, please test" paragraph and a pinned-version install command. Then highlights / what's changed scoped to this RC.

For inspiration on tone and structure, see existing notes at https://github.com/ClickHouse/clickhouse-connect/releases (e.g. v1.0.0 for a major release, v1.0.0rc3 for an RC patch).

Sources of truth for the content:

  • The CHANGELOG.md section you just renamed — every entry there should be reflected.
  • git log main..HEAD (or git log <previous-tag>..HEAD if you can determine the previous release tag) to catch anything the CHANGELOG missed.

Include an installation block (pip install clickhouse-connect for stable, pip install clickhouse-connect==$ARGUMENTS for pre-releases). Preserve issue/PR links in the form [#NNN](https://github.com/ClickHouse/clickhouse-connect/issues/NNN).

Print the notes in a fenced markdown block so the user can copy them verbatim.

6. Summary

After making the changes, show the user a short summary of what was done:

  • The branch you are on
  • The changelog update (old heading -> new heading)
  • The version bump (old version -> new version)
  • That release notes were printed above for review

Do NOT commit the changes. Let the user review and commit when ready.

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.