update-changelog

Read completed tasks from docs/tasks/ and append entries to CHANGELOG.md.

8|1|Updated Dec 9, 2024
One-click install
npx skills add https://github.com/dianlight/srat --skill update-changelog-dianlight
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: update-changelog
Source: https://github.com/dianlight/srat/tree/main/.github/skills/update-changelog
Command: npx skills add https://github.com/dianlight/srat --skill update-changelog-dianlight

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Reads completed or updated tasks from docs/tasks/ and appends structured entries to CHANGELOG.md under the [ 🚧 Unreleased ] section, following the existing changelog format.

Core Features & Use Cases

  • Reads completed or updated tasks from docs/tasks/ and appends structured entries to CHANGELOG.md under the [ 🚧 Unreleased ] section, following the project's formatting conventions.
  • Supports triggers such as update changelog, add to changelog, changelog from tasks, generate release notes, and write changelog entry to activate its workflow.
  • Maintains the existing changelog structure and sections for easy auditing and releases.

Quick Start

Run the update-changelog skill to read completed or updated tasks from docs/tasks/ and append entries to CHANGELOG.md under the [ 🚧 Unreleased ] section.

Frequently Asked Questions about update-changelog

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

FAQPage Schema
How do I automatically generate changelog entries from completed tasks?

You can generate release notes from tasks by triggering the workflow with phrases like generate release notes or changelog from tasks. It parses task status from docs/tasks/ and appends formatted bullets to the Unreleased section.

How to generate release notes from tasks without breaking my existing changelog format?

To generate release notes from tasks without breaking formatting, the Skill follows the existing changelog structure and appends entries under the [ Unreleased ] section. It preserves current sections and formats new bullets according to established conventions.

What do I need to append structured entries to CHANGELOG.md from my tasks?

You need completed or updated task files stored in the docs/tasks/ directory and an existing CHANGELOG.md file. The Skill reads these task statuses and appends structured bullets to the changelog without requiring external dependencies.

Does updating a changelog from tasks support custom trigger phrases?

Yes, updating a changelog from tasks supports natural language triggers such as update changelog, add to changelog, and write changelog entry. These phrases activate the workflow to parse tasks and append entries to the changelog.

When should I use an automated changelog generator instead of manual entry?

You should use an automated changelog generator when you have multiple completed or updated tasks in docs/tasks/ that need structured documentation. It prevents manual formatting errors and maintains consistent changelog sections for release auditing.