skills.rest
TencentBlueKing
TencentBlueKingOFFICIAL
Explore all skills by this author →
WebsiteGitHub

changelog-release-notes

Generates release summaries and translates incremental CHANGELOG version blocks between Chinese and English.

2.5k|524|Updated May 29, 2019
Search Tags:#translation#release notes#bilingual#Versioning#summary generation#ChangeLog#bk-ci
One-click install
npx skills add https://github.com/TencentBlueKing/bk-ci --skill changelog-release-notes
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: changelog-release-notes
Source: https://github.com/TencentBlueKing/bk-ci/tree/main/ai/skills/changelog-release-notes
Command: npx skills add https://github.com/TencentBlueKing/bk-ci --skill changelog-release-notes

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Maintaining bilingual CHANGELOG files for each BK-CI release is repetitive and error-prone: you must summarize only the new version block without touching history, then translate exactly that block into English while preserving links, versions, and section structure.

Core Features & Use Cases

  • Incremental Summary Generation: Reads only the target version block (e.g. v4.2.0-rc.4) and writes a concise "变更概述" (5-8 features, 2-4 bug fixes) back into the Chinese CHANGELOG.
  • Bilingual Sync: Translates the incremental block into English using fixed section/tag mappings (新增→New Features, [修复]→[Fixed]) and inserts it at the top of the English CHANGELOG.
  • History Protection: Never rewrites older versions, existing detail entries, or TOC structures; asks before overwriting an existing English version.
  • Use Case: After drafting the Chinese details for v4.2.0-rc.4, ask the agent to add the summary and sync the English log—only that block is read, summarized, translated, and inserted.

Quick Start

Process the v4.2.0-rc.4 incremental changelog block by generating its summary in the Chinese file and syncing the translation to the English CHANGELOG.

Frequently Asked Questions about changelog-release-notes

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

FAQPage Schema
How do I generate a release summary for a new CHANGELOG version?▼

Provide the target version (e.g. v4.2.0-rc.4) after writing the Chinese detail entries. The workflow reads only that version block, curates 5-8 feature highlights and 2-4 high-impact bug fixes, and inserts a 变更概述 section without touching existing details.

How to translate a Chinese CHANGELOG into English incrementally?▼

The workflow translates only the new version block using fixed mappings: 新增 becomes New Features, [修复] becomes [Fixed], and 变更概述 becomes Summary. The translated block is inserted at the top of the English file after the NEW RELEASE NOTES ENTRY marker.

Can I generate only the summary without translating to English?▼

Yes, the workflow supports partial execution. Requesting only the summary runs steps 1-3 (read block, generate summary, write back to Chinese file), while requesting only translation runs steps 1, 4, and 5 assuming the summary already exists.

Does this modify older CHANGELOG versions or existing entries?▼

No, the process is strictly incremental. It reads and writes only the target version block, never reorders or edits existing detail entries, never retranslates historical English versions, and asks before overwriting an existing English version block.

What items are excluded from the release summary?▼

Internal optimizations, performance tweaks, dependency upgrades, API field additions, and minor UI fixes are excluded by default. Only user-facing capabilities and high-impact bugs (build failures, data loss, stuck states) qualify for the summary.

Related Skills

Explore More Software Engineering Skills→
FlorianBruniauxFlorianBruniaux
5.9k

release-notes

Generate release notes in multiple formats from git commit history.

Community
Intermediate
massgenmassgen
1.1k

release-prep

Generate release documentation from commits and PRs since the last tag.

Official
Advanced
4asaanAI4asaanAI

release-notes

Generate categorized release notes from commits, pull requests, and issue activity.

Community
Intermediate
Sir-chawakornSir-chawakorn
33

changelog-generator

Generate changelogs from Git commits in Markdown format.

Community
Intermediate