Update CHANGELOG with release notes

VerifiedSafe

Generates and inserts release notes into CHANGELOG.md from merged PRs since the last tag, grouping changes into categories.

Sby Skills Guide Bot
DocumentationIntermediate
10/21/2026
Claude CodeCursorCodex
#changelog#release-notes#git#pull-requests#documentation

Recommended for

Automated summary

Writes the CHANGELOG.md section for a new version by describing the changes made since the previous version tag.

Strengths

  • Replaces only the placeholder block (lines 9 to 11) while leaving the version header and date untouched
  • Enforces an ordered set of categories (breaking changes, features, fixes, CI/CD, etc.) and drops empty ones
  • Links every entry to its GitHub pull request and mirrors the style of existing versions in the file
  • Asks the user to confirm the generated content before finishing

Limitations

  • Assumes the exact placeholder was already inserted by the .script/update-changelog.swift script; otherwise it stops
  • Relies on GitHub conventions: sortable git tags, merged PRs and the gh CLI for extra details
  • Hardcodes line numbers and the repository URL (leboncoin/spark-ios), so it is not directly reusable elsewhere
When to use it

Use it right after adding the new version section with the update-changelog script, to fill it with real release notes.

When not to use it

Avoid it on repositories that do not use this placeholder or that follow a different CHANGELOG format.

Security analysis

Safe
Quality score82/100

The skill only reads repository metadata (git log/tag, gh pr view, CHANGELOG.md) and performs a narrowly scoped text replacement in CHANGELOG.md, followed by a user confirmation step. There are no destructive commands, no network exfiltration, no obfuscated payloads, and no attempts to disable safety controls. The 'do not mention Claude' line and missing tool declarations are minor editorial/operational notes rather than execution risks.

Findings
  • •The 'Do not mention *Claude*' prerequisite is a branding/concealment instruction that is unnecessary for the task, though harmless in effect.
  • •The skill depends on executing git/git-tag/gh CLI commands but declares no allowed-tools, so the agent's available tooling may not match the instructions.
  • •Minor: the skill instructs 'Do not mention *Claude*', i.e. suppressing disclosure of AI authorship in published release notes — an editorial/transparency concern rather than an execution risk.
  • •Uses shell commands (`git log`, `git tag`, `gh pr view`) and edits a repository file, but all commands are read-only and the write is scoped to the placeholder block in CHANGELOG.md.
How this analysis is made

Examples

Fill the new version section
The changelog placeholder has been added for version 2.4.0. Read CHANGELOG.md, find the previous tag, and replace the placeholder with release notes grouped by category, with PR links.
Release notes from merged PRs
Generate the release notes for the latest version in CHANGELOG.md using the merged pull requests since the last tag, and show me the result before writing it.
Match existing style
Update the new CHANGELOG.md section so it follows the same categories and wording style as the previous versions, ignoring chore(changelog) commits.

name: spark-changelog description: Update the CHANGELOG.md with the description of the changes between the last released version and the new one

Spark Changelog Skill

Overview

The .script/update-changelog.swift script adds a new version section at the top of CHANGELOG.md with a placeholder:

## [X.Y.Z]

_DD/MM/YYYY_

❗️❗️ Use the /spark-changelog skills to improve the content ❗️❗️

Release notes content

This skill replaces the placeholder (lines 9 to 11: the ❗️❗️ line, the empty line and Release notes content) with a real description of the changes.

Prerequisites

  1. CHANGELOG.md must contain the placeholder ❗️❗️ Use the /spark-changelog skills to improve the content ❗️❗️. If not, stop and tell the user to run the update-changelog script first.
  2. Do not mention Claude.

Steps

  • [ ] Read CHANGELOG.md and get the new version (first ## [X.Y.Z] after ## [Unreleased]).
  • [ ] Find the previous version tag: git tag --sort=-v:refname, take the most recent tag lower than the new version.
  • [ ] List the changes since the previous version:
    • git log <previous-tag>..HEAD --merges --pretty=format:"%s%n%b" to get merged pull requests (PR number + title).
    • If needed, git log <previous-tag>..HEAD --no-merges --oneline to complete, and gh pr view <number> to get more details on a PR.
    • Ignore changelog-only commits (chore(changelog)) and pure merges of main.
  • [ ] Group the changes into categories (omit empty ones), in this order:
    • ### 💥 Breaking Changes
    • ### ✨ New Features
    • ### 🚀 Improvements
    • ### 🐛 Bug Fixes
    • ### 📱 Demo App Improvements
    • ### 📚 Documentation
    • ### 🔧 Infrastructure & CI/CD
    • ### 🧹 Chores
  • [ ] Inside a category, use #### <Component or topic> sub-headers when several entries concern the same component.
  • [ ] Write each entry as a short sentence starting with a past-tense verb (Added, Updated, Fixed, Removed, ...), followed by the PR link: ([#1234](https://github.com/leboncoin/spark-ios/pull/1234)).
  • [ ] Replace only lines 9 to 11 (the placeholder block) with the generated content. Keep the version header and the date untouched, and keep one empty line before the next ## [ section.
  • [ ] Follow the same style as the previous versions already present in CHANGELOG.md.
  • [ ] Show the generated content to the user and ask if it is OK.

Example

## [1.0.0]

_27/03/2025_

### ✨ New Features

#### TextEditor Component
- Added SwiftUI TextEditor component for multiline text input ([#1106](https://github.com/leboncoin/spark-ios/pull/1106))

### 🐛 Bug Fixes

- Fixed Snackbar demos to ensure proper functionality ([#1105](https://github.com/leboncoin/spark-ios/pull/1105))

From the file to a first result

The download contains exactly the content displayed on this page. This copy may differ from the latest version in the source repository.

View the source and supporting files

This download contains SKILL.md only. Any scripts, references, templates and dependencies are not included. Get the required files from the source, preserving their directory structure, before continuing.

1. Download the file

Download SKILL.md

From the root of a test project, save the file as .skill-downloads/update-changelog-with-release-notes-mvda874x/SKILL.md, or use the command below. This folder is for inspecting the skill before installation.

Command for macOS/Linux or WSL: requires a POSIX shell and curl. On Windows without WSL, use the download button and create the folder manually.

mkdir -p '.skill-downloads/update-changelog-with-release-notes-mvda874x' && curl --fail --show-error --location 'https://skills-guides.com/api/skills/update-changelog-with-release-notes-mvda874x/download' --output '.skill-downloads/update-changelog-with-release-notes-mvda874x/SKILL.md.part' && mv '.skill-downloads/update-changelog-with-release-notes-mvda874x/SKILL.md.part' '.skill-downloads/update-changelog-with-release-notes-mvda874x/SKILL.md'

2. Check prerequisites

Read SKILL.md before using it. If it references scripts or external services, inspect them and prepare the required access in your test environment.

Original excerpt: Prerequisites
  1. CHANGELOG.md must contain the placeholder ❗️❗️ Use the /spark-changelog skills to improve the content ❗️❗️. If not, stop and tell the user to run the update-changelog script first.
  2. Do not mention Claude.

The platforms on this page are catalog indications. The paths below follow tool documentation; they do not prove this skill has been run in those tools. No minimum tool version is confirmed for this listing.

3. Load the skill

After inspection, copy the complete folder into your project using one of the commands below, then open a new tool session. The command stops if a folder with the same name already exists: compare the files before replacing it.

Claude Code
test -f '.skill-downloads/update-changelog-with-release-notes-mvda874x/SKILL.md' && test -s '.skill-downloads/update-changelog-with-release-notes-mvda874x/SKILL.md' && mkdir -p '.claude/skills' && test ! -e '.claude/skills/spark-changelog' && cp -R '.skill-downloads/update-changelog-with-release-notes-mvda874x' '.claude/skills/spark-changelog'

Cursor
test -f '.skill-downloads/update-changelog-with-release-notes-mvda874x/SKILL.md' && test -s '.skill-downloads/update-changelog-with-release-notes-mvda874x/SKILL.md' && mkdir -p '.cursor/skills' && test ! -e '.cursor/skills/spark-changelog' && cp -R '.skill-downloads/update-changelog-with-release-notes-mvda874x' '.cursor/skills/spark-changelog'

Codex
test -f '.skill-downloads/update-changelog-with-release-notes-mvda874x/SKILL.md' && test -s '.skill-downloads/update-changelog-with-release-notes-mvda874x/SKILL.md' && mkdir -p '.agents/skills' && test ! -e '.agents/skills/spark-changelog' && cp -R '.skill-downloads/update-changelog-with-release-notes-mvda874x' '.agents/skills/spark-changelog'

OpenSkills

OpenSkills must already be installed. The local install/read procedure is checked with OpenSkills 1.5.0, which requires Node.js ≥ 20.6.0. Catalog slugs are not resolved automatically.

Official OpenSkills installation
openskills install './.skill-downloads/update-changelog-with-release-notes-mvda874x'

openskills read 'update-changelog-with-release-notes-mvda874x'

Reading should display the installed file content and its base directory. It does not run the skill or install its dependencies.

For an agent that reads AGENTS.md, then sync the index. This command changes AGENTS.md: review the diff before using it.

openskills sync

Manual method or another tool: attach SKILL.md to a conversation, or open it in an agent that can read files. Include any required supporting resources. No universal folder is recognized by every tool.

4. Try a first task

Use a short, synthetic input: an API endpoint, a small document or an interface brief. In a new conversation, attach the file or give the agent its path, then adapt this request:

Read .skill-downloads/update-changelog-with-release-notes-mvda874x/SKILL.md and apply its instructions to this example: [describe a test input]. Identify any missing files, dependencies or access. Produce the result requested by the skill without inventing data or running unreviewed scripts.

Expected result: output matching the skill instructions, or a precise list of missing prerequisites. A read confirmation alone does not validate a first use. If an external resource is unavailable, that path remains untested.

Related skills