Agent skill

Release Notes

by pingcap in pingcap/docs

Evaluate whether a change needs a release note. An agent skill from pingcap/docs.

Custom licenceAuto-check passedDevelopment

Install Release Notes

skills CLI
$ npx skills add pingcap/docs --skill release-notes -a claude-code

Project install by default; add -g for ~/.claude/skills/.

GitHub CLI
$ gh skill install pingcap/docs release-notes --agent claude-code

Project scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).

Manual copy
$ git clone --depth 1 https://github.com/pingcap/docs.git skills-src && mkdir -p .claude/skills && cp -r skills-src/.agents/skills/write-review-translate-release-notes .claude/skills/release-notes && rm -rf skills-src

Use ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.

Claude Code skills documentation · loads skills from .claude/skills/

Facts

Skill name
release-notes
GitHub stars
616
Token cost
~2.6k tokens
SKILL.md length
1,103 words
Files
6 (incl. references)
Skills in repo
8
Repo updated
First seen
Licence
Custom licence

At a glance

Evaluate whether a change needs a release note. An agent skill from pingcap/docs.

  • Works in 4 steps: Read the backport PR first. → If the backport PR body omits details,… → Base the release note on the actual… → …
  • Triaging PRs for release-note relevance
  • SKILL.md covers When to use this skill, Determine whether a change…, Which reference to load and File-level structure, plus 1 more section
  • Reaches github.com and docs.pingcap.com

What it does

Release Notes is an agent skill from pingcap/docs. Evaluate whether a change needs a release note. If yes, write, review, revise, or translate TiDB release note entries for the features, compatibility changes, improvements, and bug fixes sections. Use this skill when triaging PRs for release-note relevance, working with release note entries, aligning English and Chinese content, auditing release-X.X.X.md files, or editing files under docs/releases/ or docs-cn/releases/.

Its SKILL.md is about 2.6k tokens, which your agent loads only when the skill is triggered. The skill folder holds 6 other files, including reference files (for example `references/bilingual-alignment.md`, `references/bug-fixes.md` and `references/compatibility-changes.md`).

It sits in Development, covering Changelog and release notes. It works with TiDB and GitHub. The repository describes itself as: TiDB database documentation. TiDB is an open-source, cloud-native, distributed, MySQL-Compatible database for elastic scale and real-time analytics.

When your agent uses it

  • Triaging PRs for release-note relevance
  • Working with release note entries
  • Aligning English and Chinese content
  • Auditing release-X.X.X.md files

Example prompts

  • “/release-notes”

Workflow steps

4 steps, taken from the first numbered list in SKILL.md.

  1. Read the backport PR first.
  2. If the backport PR body omits details, follow the link to the original upstream PR and its linked issues.
  3. Base the release note on the actual behavior change described in the original PR or issue, not the cherry-pick mechanics.
  4. Ignore cherry-pick metadata (such as cherry-pick from #XXXXX) in the release note text.

What it can do on your machine

Read from SKILL.md and the folder at commit 6ba8576. It shows what the files ask for, not the result of running them.

  • Tool permissions

    Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.

    From allowed-tools in the SKILL.md frontmatter.

  • Runs code

    No scripts in the folder and no shell commands in SKILL.md (its code samples are markdown).

    From the folder's file list and the shell code blocks in SKILL.md.

  • Network

    Hosts in commands or code, which the agent is likely to contact:

    • github.com
    • docs.pingcap.com

    From URLs in SKILL.md, links to its own repository left out.

  • Credentials

    Names no API keys, tokens, secrets or passwords.

    From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.

Context cost

Release Notes loads about 2.6k tokens when it runs, and up to ~15k if it reads all its reference files. Until then it costs about 111 tokens; SKILL.md has 1,103 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it
~111
When it runs · the whole SKILL.md, loaded when a task matches
~2.6k
With references · SKILL.md plus every file in references/, read only if the agent opens them
~15k

Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.

Safety

Auto-check passed

The automated check found no risky patterns in SKILL.md.

Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.

SKILL.md

Its licence (Custom licence) doesn't allow us to republish the file, so here is its outline and opening line. It has 1,103 words (~2,564 tokens).

“When you evaluate whether a change needs a release note, write, review, or translate a release note entry (including feature descriptions, compatibility changes, improvements, and bug fixes), use this skill to load the right references, apply the correct patterns, and…”

— opening of SKILL.md by pingcap, Custom licence
name
release-notes

Read the full SKILL.md on GitHub

Files

SKILL.md and 5 other files (references) in .agents/skills/write-review-translate-release-notes of pingcap/docs.

  • SKILL.md
  • references/bilingual-alignment.md
  • references/bug-fixes.md
  • references/compatibility-changes.md
  • references/feature-description.md
  • references/improvements.md

Open the folder on GitHubat commit 6ba8576

Compare with similar skills

Release Notes next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.

Release Notes compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
Release Notes this skillpingcap/docs616—~2.6kAutomated safety check: PassCustom licence
Cutting A ReleaseTriliumNext/Trilium38k—~3.2kAutomated safety check: PassAGPL-3.0
Mole CLI Release Flowtw93/Mole70k—~2.5kAutomated safety check: PassGPL-3.0
Draft Release Notesjamiepine/voicebox57k—~941Automated safety check: PassMIT
Mole Release Notes Publishertw93/Mole70k—~1.9kAutomated safety check: PassGPL-3.0
Release Bumpjamiepine/voicebox57k—~1.1kAutomated safety check: PassMIT

Similar skills

  • Cutting A Release

    TriliumNext/Trilium

    A skill your agent uses when cutting, preparing, or debugging a Trilium release — bumping the monorepo version, tagging, or diagnosing a failed "Release" workflow run.

    38k GitHub stars~3.2k tokensUpdated today
    DevelopmentAuto-check passed
  • Runbook for assessing and executing a Mole CLI release: distribution channels, pre-flight checks, capital-V tags, build artifacts and the handoff to curated release notes.

    70k GitHub stars~2.5k tokensUpdated today
    DevelopmentAuto-check passed
  • Draft Release Notes

    jamiepine/voicebox

    Writes or refreshes the Unreleased section of CHANGELOG.md as a themed narrative built from the commits, PRs and diff since the last version tag.

    57k GitHub stars~941 tokensUpdated yesterday
    DevelopmentAuto-check passed
  • Publishes curated, bilingual release notes for an existing Mole version tag with gh release edit, including contributor thanks and reactions, after the release workflow finishes.

    70k GitHub stars~1.9k tokensUpdated today
    DevelopmentAuto-check passed
  • Release Bump

    jamiepine/voicebox

    Ends a release cycle by moving the Unreleased changelog notes under a dated version heading, bumping version files with bumpversion and tagging the commit.

    57k GitHub stars~1.1k tokensUpdated yesterday
    DevelopmentAuto-check passed
  • Cut Release

    jfernandez/bpftop

    Cut a new versioned release of bpftop — pick the version, open a version-bump PR, sign-tag the merge commit on main, and draft GitHub release notes in the project's established format.

    2.7k GitHub stars~2k tokensUpdated 1 mo ago
    DevelopmentAuto-check passed

More from pingcap/docs

All 8 skills in this repo
  • Produces and merges Related resources cards for TiDB docs pages using the RelatedResources and ResourceCard MDX components.

    616 GitHub stars~1.8k tokensUpdated yesterday
    Auto-check passed
  • Create or update a zh translation PR from pingcap/docs to pingcap/docs-cn by using repo-local scripts to prepare change-unit translation inputs, apply minimal edits to the existing Chinese files…

    616 GitHub stars~2.9k tokensUpdated yesterday
    Auto-check passed
  • Write new TiDB documentation or update existing TiDB documentation from code changes, PRs, issues, design docs, product specs, rough drafts, existing docs, or short feature descriptions.

    616 GitHub stars~2.3k tokensUpdated yesterday
    Auto-check passed
  • Writes or updates the front matter summary field in pingcap/docs and pingcap/docs-cn Markdown files.

    616 GitHub stars~1.8k tokensUpdated yesterday
    Auto-check passed
  • A skill your agent uses when creating or editing GitHub issues in pingcap/docs so issue templates, required fields, scope boundaries, and labels stay consistent with repository workflow.

    616 GitHub stars~1.8k tokensUpdated yesterday
    Auto-check passed
  • A skill your agent uses when creating or editing pull requests in pingcap/docs so the PR template sections, version checkboxes, related-link fields, HTML comments, and description structure stay…

    616 GitHub stars~1.9k tokensUpdated yesterday
    Auto-check passed

Works with

Categories

Questions about Release Notes

What does Release Notes do?

Evaluate whether a change needs a release note. An agent skill from pingcap/docs. Release Notes is an agent skill from pingcap/docs. Evaluate whether a change needs a release note.

When should I use Release Notes?

Release Notes fits situations like: triaging PRs for release-note relevance; working with release note entries; aligning English and Chinese content; auditing release-X.X.X.md files.

How do I install Release Notes in Claude Code?

Run `npx skills add pingcap/docs --skill release-notes -a claude-code`. Or copy the skill folder (.agents/skills/write-review-translate-release-notes in pingcap/docs) into .claude/skills/release-notes in your project. Claude Code loads it when a task matches its description.

How do I install Release Notes in Codex?

Run `npx skills add pingcap/docs --skill release-notes -a codex`. Or copy the skill folder (.agents/skills/write-review-translate-release-notes in pingcap/docs) into .agents/skills/release-notes in your project. Codex loads it when a task matches its description.

Can I use Release Notes in Cursor, Gemini CLI or GitHub Copilot?

Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add pingcap/docs --skill release-notes -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/release-notes, .gemini/skills/release-notes, .github/skills/release-notes and .opencode/skills/release-notes in your project.

What does Release Notes need to run?

SKILL.md names no scripts, command-line tools or credentials: Release Notes is instructions for the agent only.

Does Release Notes access the network?

SKILL.md names 2 domains. In commands or code: github.com and docs.pingcap.com; the agent is likely to contact these when it follows the instructions. This is read from the text; nothing was executed.

Is Release Notes safe to install?

Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. Review the folder before installing.

What licence does Release Notes use?

Release Notes has a licence file (the repository's licence) that doesn't match a standard licence. Read it on GitHub before reusing the skill.

How many tokens does Release Notes use?

About 2.6k tokens (SKILL.md is roughly 10k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full. Its references folder adds about 12k tokens, read only when the agent opens those files.

What are the alternatives to Release Notes?

Skills that share tags, products or a category with Release Notes: Cutting A Release (TriliumNext/Trilium, 38k stars), Mole CLI Release Flow (tw93/Mole, 70k stars), Draft Release Notes (jamiepine/voicebox, 57k stars) and Mole Release Notes Publisher (tw93/Mole, 70k stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Release Notes?

pingcap (a GitHub organization) maintains it in pingcap/docs, which has 616 GitHub stars. The repository holds 8 skills in this directory. The repository was last updated on October 7, 2026.

Source: pingcap/docs on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.