docs-changelog

Generate release changelog files from version, timestamp, and raw notes.

Updated Jan 23, 2024
One-click install
npx skills add https://github.com/TeamMagicOfConch/conch --skill docs-changelog-teammagicofconch
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: docs-changelog
Source: https://github.com/TeamMagicOfConch/conch/tree/main/.agents/skills/docs-changelog
Command: npx skills add https://github.com/TeamMagicOfConch/conch --skill docs-changelog-teammagicofconch

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires [], and includes references (resource) components.

What problem does it solve?

Generates and standardizes release changelog content by transforming version, time, and raw release notes into consistent files.

Core Features & Use Cases

  • Automates generation of latest.md, preview.md, and index.md from release data and templates.
  • Reflows and highlights updates, updates the Full Changelog link, and removes optional sections like New Contributors.
  • Applies deterministic processing steps and validates style guidelines for markdown templates.

Quick Start

Provide version, TIME, and BODY to generate and update all changelog files.

Frequently Asked Questions about docs-changelog

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

FAQPage Schema
How do I automate release notes formatting for multiple markdown files?

Automate release notes formatting by processing version, timestamp, and raw text to generate consistent latest.md, preview.md, and index.md files. The workflow applies markdown templates, reflows content, and highlights updates automatically.

How does changelog generation handle version path routing and time formatting?

Changelog generation uses deterministic processing steps to route version paths and format timestamps accurately. It transforms raw release notes into structured markdown files while validating style guidelines.

Can I automatically remove optional sections like New Contributors from generated changelogs?

Yes, the changelog generation process automatically removes optional sections like New Contributors during content reflow. It also updates the Full Changelog link and applies style checks to ensure markdown consistency.

What is the best way to generate consistent highlights across preview and index pages?

Generate consistent highlights by applying deterministic templates to raw release data. This approach standardizes the formatting of preview and index pages, ensuring all changelog entries adhere to uniform style guidelines.

Do I need to provide raw release notes to update the Full Changelog link?

Yes, you must provide the version, TIME, and raw release notes as input. The system uses this data to populate templates, reflow content, and accurately update the Full Changelog link across all generated files.