generate_release_note

Generate EN/JA release notes from git diffs between version tags.

21|11|Updated Jun 18, 2023
One-click install
npx skills add https://github.com/Jij-Inc/Qamomile --skill generate-release-note
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: generate_release_note
Source: https://github.com/Jij-Inc/Qamomile/tree/main/.claude/skills/generate_release_note
Command: npx skills add https://github.com/Jij-Inc/Qamomile --skill generate-release-note

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill removes the manual, error-prone effort of writing release notes by automatically assembling a structured EN/JA changelog from git diffs between the previous tag and the current main branch.

Core Features & Use Cases

  • Version-aware EN/JA note generation: Creates matching docs for docs/en/release_notes/v<X_Y_Z>.md and docs/ja/release_notes/v<X_Y_Z>.md, using the correct version numbering and required section layout.
  • User-facing change classification: Categorizes changes from the user’s perspective (breaking changes, new features, internal changes, bug fixes, and documentation) while avoiding commit-message bias.
  • Consistency with existing style and verification rules: Reuses the most recent release note’s conventions for layout and phrasing, and enforces snippet-linking and formatting rules for PR references and tutorial pointers.

Quick Start

Ask it to generate release notes from v0.11.1 to v0.12.0 by running: generate_release_note v0.11.1 v0.12.0

Frequently Asked Questions about generate_release_note

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

FAQPage Schema
How do I generate bilingual release notes from a git diff between version tags?

Generate bilingual release notes by analyzing the git diff between the previous version tag and current main branch, producing structured documentation files under docs/en/release_notes and docs/ja/release_notes.

How does automated release note generation categorize changes from a git diff?

Automated release note generation classifies user-facing changes from the git diff into categories like breaking changes, new features, internal changes, bug fixes, and documentation, avoiding bias from raw commit messages.

What is the best way to automate EN and JA changelog creation for versioned documentation?

Automate EN and JA changelog creation by deriving structured release notes from git history, ensuring consistent section ordering, pip-install header formatting, and correct PR and tutorial link formatting across both languages.

Can I automatically update myst index files when generating release notes?

Yes, generating versioned release note files under docs/en/release_notes and docs/ja/release_notes automatically updates the corresponding myst index files to maintain documentation index consistency.

How do I ensure consistent formatting and section ordering across multiple bilingual release notes?

Ensure consistent formatting by reusing the most recent release note’s conventions for layout and phrasing, enforcing mandatory section ordering, and applying verified snippet output conventions for PR references.

Does automated release note generation require specific version tag formats to work correctly?

Automated release note generation requires valid previous and current version tags, such as v0.11.1 and v0.12.0, to accurately calculate the git diff and apply the correct version numbering to the output files.