skills.rest
thachrocky12345
thachrocky12345COMMUNITY
Explore all skills by this author →
GitHub

sdk-changelog

Generate changelogs, release notes, and announcement posts for SDK pod packages using tag-based GitFlow.

Updated May 11, 2026
Search Tags:#changelog#sdk#release notes#monorepo#semver#gitflow#slack announcement
One-click install
npx skills add https://github.com/thachrocky12345/local-agent-train-workstation --skill sdk-changelog-thachrocky12345
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: sdk-changelog
Source: https://github.com/thachrocky12345/local-agent-train-workstation/tree/main/qvac/.cursor/skills/sdk-changelog
Command: npx skills add https://github.com/thachrocky12345/local-agent-train-workstation --skill sdk-changelog-thachrocky12345

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve? Preparing an SDK release requires manually assembling changelogs from merged PRs, writing human-readable release notes, drafting Slack announcements, and updating NOTICE files — a repetitive, error-prone process across a monorepo of pod packages. ## Core Features & Use Cases - Tag-based changelog generation: Resolves the correct base tag (minor vs. patch release) and generates raw CHANGELOG.md, breaking.md, api.md, and models.md files scoped to the target package. - Human-readable release notes: Transforms raw changelogs into polished CHANGELOG_LLM.md documents with narrative prose, migration guides, and code examples. - Slack announcement posts: Produces a gitignored announcement-post.txt formatted for Slack with sections, breaking-change warnings, and release links. - Use Case: When releasing version 0.9.0 of the sdk package, run the skill to auto-detect the base tag, generate all changelog files, write the release notes, create the Slack post, and refresh the NOTICE file in one workflow. ## Quick Start Ask the AI to generate the changelog and release notes for the sdk package using the sdk-changelog skill.

Frequently Asked Questions about sdk-changelog

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I generate a changelog for an SDK pod package?▼

Run the generate-changelog-sdk-pod.cjs script with the --package flag, for example --package=sdk. The script fetches tags from the upstream remote, resolves the correct base tag, and writes changelog files to packages/<package>/changelog/<version>/.

How does the changelog script choose the base tag for a release?▼

The script auto-detects the release type from package.json. Minor releases (version ending in .0) use the latest .0 tag as base, while patch releases use the absolute latest tag. If no tags exist, you must supply --base-commit and --base-version.

What is CHANGELOG_LLM.md and is it required?▼

CHANGELOG_LLM.md is a human-readable release notes document generated from the raw changelog files, following the format guide in references/changelog-llm-format.md. It is a mandatory step in the workflow and the root aggregate changelog prefers it over the raw CHANGELOG.md.

Why are some PRs missing from the generated changelog?▼

The script excludes PRs tagged [skiplog], backmerge PRs whose content is already documented in release branch changelogs, and PRs whose titles fail the SDK PR-format validator. Invalid titles are warned about so they can be fixed and the script re-run.

Can I commit the announcement-post.txt file to the repository?▼

No, announcement-post.txt is gitignored by design as a local working artifact for Slack copy-paste. You can hand-edit it for custom summaries, but it should never be added to git.

Related Skills

Explore More Software Engineering Skills→
bitan-delbitan-del
7

bump-version

Automate the Gods Eye version bump workflow from package.json updates to release tagging.

Community
Advanced
lucasadcapital-beeplucasadcapital-beep

release

Coordinate software releases across changelog, canary validation, and GitHub publishing.

Community
Advanced
MoonshotAIMoonshotAI
11.1k

release

Automate multi-package release workflows for Kimi Code CLI.

Official
Advanced
mia-cxmia-cx

release

Automate software releases with versioning, changelog generation, and GitHub releases.

Official
Advanced