draft-release-notes

Generate UDS Core release notes pages and Slack summaries from release-please PRs.

191|45|Updated Oct 23, 2023
One-click install
npx skills add https://github.com/defenseunicorns/uds-core --skill draft-release-notes
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: draft-release-notes
Source: https://github.com/defenseunicorns/uds-core/tree/main/.claude/skills/draft-release-notes
Command: npx skills add https://github.com/defenseunicorns/uds-core --skill draft-release-notes

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Draft or update UDS Core release notes pages and Slack announcements from the release-please PR. Use this skill whenever preparing a release, writing announcements, updating release pages, or referencing a release-please PR.

Core Features & Use Cases

  • Generate release notes pages from PR changes and known issues.
  • Create Slack announcements aligned with the release notes template.
  • Extract and consolidate changes, assets, and dependencies for a cohesive release narrative.

Quick Start

Draft the release notes and Slack announcement for the latest release-please PR by following templates and extracting changes.

Frequently Asked Questions about draft-release-notes

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

FAQPage Schema
How do I draft release notes from a release-please PR automatically?

Draft release notes from a release-please PR by extracting change details and formatting them into a documentation page and a Slack-ready summary. The skill consolidates changes, assets, and dependencies to ensure consistency with official templates.

Can I generate a Slack announcement and a docs page for minor, patch, and major releases?

Yes, you can generate a Slack announcement and a docs page for minor, patch, and major releases. It extracts changes from the release-please PR and applies official formatting recommendations to produce both outputs.

What is the best way to consolidate change details for a UDS Core release narrative?

The best way to consolidate change details for a UDS Core release narrative is to extract and consolidate changes, assets, and dependencies from the release-please PR into a cohesive release notes page and Slack summary.

Does this release notes generator require manual template formatting?

No, manual template formatting is not required. It reproduces the official template and formatting recommendations automatically, ensuring the generated release notes page and Slack summary maintain consistency with established documentation standards.

How do I update existing release notes pages when preparing a new release?

Update existing release notes pages by referencing the release-please PR and extracting the latest change details. It applies official formatting recommendations to update the documentation page and generate a Slack-ready summary.

When do I need to use a dedicated release notes drafting tool instead of manual documentation?

Use a dedicated release notes drafting tool whenever preparing a release, writing announcements, updating release pages, or referencing a release-please PR to ensure template consistency and cohesive narrative generation.