Skip to content
Skills Library
Marketing & content · Writing

release-notes

/release-notes

Draft the GitHub release body for a new Docus version. Use when asked to write release notes, do the release notes, or prepare the GitHub release for a version. Generates emoji sections, Contributors and new docs candidates from CHANGELOG.md into a local file to edit and paste, plus Highlights on minor and major versions.

Repository
docus ↗
Licence
MIT
Last repository change
20.10.2026

Assessment and security

100/ 100Class: good
Format25 / 25
Frontmatter with name and description, valid name, description up to 1,024 characters, name matching the folder.
Discoverability25 / 25
Description explains when to use the skill, has a reasonable length and uses third person.
Content35 / 35
At least 150 words and at most 500 lines, headings, step lists, examples or code.
Hygiene15 / 15
No placeholders such as TODO, no Windows paths, with a licence.
Riskno signals detected in the scan
Files in this package
2
Scripts
1
HTML comments
1
URLs in SKILL.md
4
Deprecation

No signals detected. Repository changed on 20.10.2026, without references to retired models or APIs.

Licence

MIT, open: use and modify while retaining author attribution.

What to check before installing
  • 1 scripts in this package. Review them before installing, as Claude may execute them.
  • SKILL.md zawiera komentarze HTML (1). Nie widać ich w podglądzie Markdown, a model je czyta.

Scripts: scripts/generate.mjs

What it does and when to use it

Draft the GitHub release body for a new Docus version. Use when asked to write release notes, do the release notes, or prepare the GitHub release for a version. Generates emoji sections, Contributors and new docs candidates from CHANGELOG.md into a local file to edit and paste, plus Highlights on minor and major versions.

Original author description

Draft the GitHub release body for a new Docus version. Use when asked to write release notes, do the release notes, or prepare the GitHub release for a version. Generates emoji sections, Contributors and new docs candidates from CHANGELOG.md into a local file to edit and paste, plus Highlights on minor and major versions.

How it works

  1. Steps
  2. Format notes (kept in sync with past releases)
Original SKILL.md headings · 132 lines, 795 words
SKILL.md preview
---
name: release-notes
description: Draft the GitHub release body for a new Docus version. Use when asked to write release notes, do the release notes, or prepare the GitHub release for a version. Generates emoji sections, Contributors and new docs candidates from CHANGELOG.md into a local file to edit and paste, plus Highlights on minor and major versions.
---

Produce the full GitHub release body for a new Docus version, based on
`CHANGELOG.md`, into `v<version>.md` at the repo root. The user edits it and
pastes it into the GitHub release. The generator does everything mechanical;
**you** write the Highlights and the New documentation list (the parts that
need judgement and verification).

**When to run:** `pnpm release` writes the `CHANGELOG.md` block, tags, pushes and
opens a prefilled GitHub release in the browser. Run this skill at that point;
the generated body replaces the prefilled one.

**Patch releases** (`x.y.z` with `z > 0`) have no Highlights section. The
generator detects this from the version, so for a patch skip step 2.

## Steps

### 1. Generate the scaffold

```bash
node .claude/skills/release-notes/scripts/generate.mjs        # newest version in CHANGELOG.md
node .claude/skills/release-notes/scripts/generate.mjs 5.16.0 # a specific version
```

This reads the version block of `CHANGELOG.md` and writes `v<version>.md` with:

- a `## ✨ Highlights` placeholder (yours to fill), minor and major versions only,
- the `Breaking Changes` / `Features` / `Bug Fixes` / `Performance` / `Reverts`
  sections with emoji headers, copied from the changelog,
- `## 💚 Contributors`: PR authors and commit co-authors (one `gh api graphql`
  call), `@larbish` first then by contribution count,
- a `## 📚 New documentation` placeholder when `docs/content/en` changed,
- the `**Full Changelog**` compare line.

It prints the **highlight candidates** (Features, Performance and Breaking
Changes bullets) and the **new documentation candidates** (new pages and new
`##`/`###` headings). `gh` must be authenticated (`gh auth status`).

### 2. Write the Highlights (minor and major versions only)

Skip this step for a patch release, even when a fix is notable.

Pick **2 to 4** changes, most impactful first. Candidates include Performance:
a minor can ship without features (v5.15.0 was all performance work).

Good highlight material:

- a **new capability** users turn on or configure (an `app.config.ts` key, a
  `nuxt.config.ts` option, a new component, slot or composable),
- a **broad or cross-cutting** change (assistant, MCP, llms.txt and agents,
  search, SEO, i18n, theming, performance),
- something that closes a long-standing or popular request.

Skip narrow fixes, docs fixes and internal refactors. For each highlight write:

````md
### 🤖 Short title

One or two sentences on what it does and why it matters, linking the
[guide](https://docus.dev/en/ai/assistant#custom-provider).

```ts [app.config.ts]
// a minimal, real example
```

> [!TIP]
> Optional callout for a caveat or neat detail.
````

Rules:

- **Verify before you write.** Check option names, defaults and components
  against the merged PR (`gh pr view <n> --repo nuxt-content/docus`),
  `docs/content/en/**`, `layer/index.d.ts` (`nuxt.config` options),
  `layer/app/types/index.d.ts` and `layer/nuxt.schema.ts` (`app.config`),
  `layer/modules/**` and `layer/app/components/**`. Never invent an API.
- **Match the voice**: concise, direct, no em dashes, reads like Baptiste wrote it.
  Look at the last few releases for tone:
  `gh release list --repo nuxt-content/docus --limit 5`, then
  `gh release view <tag> --repo nuxt-content/docus`.
- **Describe what actually shipped, not what it enables.** A title must match the
  real change. Don't inflate a small option into a big feature (e.g. a `vary`
  header on markdown negotiation is a caching fix, not "agent-ready docs").
- When unsure, prefer fewer, accurate highlights over four.
- Emojis: `🤖` assistant/MCP/agents, `🏎️` performance, `🔍` search/SEO,
  `🎨` theming/customization, `🌐` i18n, `🧩` components, `♿` accessibility.

### 3. Breaking changes and upgrade notes

If there is a `⚠️ Breaking Changes` section, or a feature/fix requires users to
change their project on upgrade (check the PR description), add a callout with
the migration step and a docs link, right below the related section:

```md
> [!WARNING]
> What changed, what to do, and a [link to the docs](https://docus.dev/en/...).
```

### 4. Fill New documentation (any release with candidates)

Keep only pages and sections that document something new in this release.
Drop headings that were renamed, moved or reworded. Check each anchor against
the heading on the page. List them as bare URLs, one per bullet:

```md
## 📚 New documentation

* https://docus.dev/en/ai/assistant#custom-provider
```

Delete the section if nothing qualifies.

### 5. Sanity-check and report

- Confirm the contributor list looks right. Co-authors whose email isn't linked
  to a GitHub account are missed:
  `git log <prev>..<tag> --pretty=%b | grep -i co-authored-by`.
- Remove any leftover `<!-- TODO -->` comment.
- Tell the user the file path, which highlights you chose (minor/major only),
  and which docs links you kept.
- Do **not** commit it. It's a scratch file (ignored by `.gitignore`) the user
  pastes into GitHub.

## Format notes (kept in sync with past releases)

- Section order: Highlights → Breaking Changes → Features → Bug Fixes →
  Performance → Reverts → Contributors → New documentation → Full Changelog.
- Patch releases skip Highlights and start at the first changelog section.
- Headers use unicode emojis (`## 🚀 Features`), not `:shortcodes:`.
- `Performance Improvements` is renamed to **Performance**.
- Docs URLs drop numeric prefixes: `docs/content/en/4.ai/1.assistant.md` →
  `https://docus.dev/en/ai/assistant`.
Files in this package (2)
  • SKILL.md 6 KB
  • scripts/generate.mjs 9 KB

Versions

RepositoryScoreLicence
This page · nuxt-content/docus100MIT
mono/SkiaSharp100MIT
niekcandaele/claude-helpers100MIT
kenryu42/cc-safety-net100MIT
zeitlos/lucity100AGPL-3.0
openshift-pipelines/pipelines-as-code100Apache-2.0
paperwingio/paperwing100Apache-2.0
jelvodev/yaap100MIT
yearzen1/LocalSkillManager100MIT

Database snapshot: 13.11.2026 · package version d718ebd31510 (SHA-256 digest of the entire package)

Downloads in the last 30 days: 0 · ranking

Report a problem with this skill: harmful content, incorrect descriptions or an author’s removal request.

Similar skills

  • 100create-release-notes
    Generate user-facing release notes when the user asks to write release notes, document a release, summarize changes for users, or prepare a changelog between versions
  • 100release-note-publisher
    Draft, refine, and publish bilingual PigeonPod GitHub release notes from commits on the `release` branch. Use when Codex needs to compare commits since the latest published GitHub release, write a new local release note under `dev-docs/release-notes`, align English and Chinese…
  • 100changelog
    Write release notes or a CHANGELOG.md entry from git history. Use when the user says "write the changelog", "release notes for v2.3", "what changed since the last release/tag", or is preparing a release or version bump.
  • 100release-notes-generator
    Generates human-readable release notes from merged pull requests, commits, or changelogs between version references or date ranges. Groups changes by type (features, fixes, breaking changes), formats for multiple targets (repository releases, chat posts, wiki pages, plain…
  • 100git-whats-new
    Write "What's New in This Version" release notes for the App Store, Google Play or a changelog from the user-visible changes on the current branch or in the last N commits - 3 to 6 short English bullets in one block ready to paste. Use when the user asks for release notes, store…
  • 100minutes-release-notes
    Draft user-facing Minutes release notes for a version from the commit range, recent GitHub releases, and the repository release checks. Use when the user asks to write, generate, prepare, revise, or review release notes or a changelog for a Minutes version.

Feedback and reports

Your message goes to Bartosz Sokoliński. An email address is needed only for a reply. See the privacy policy.