skills.rest
music-brain88
music-brain88COMMUNITY
Explore all skills by this author →
GitHub

release-note

Generate GitHub release notes from pull request details via shell scripting.

15|1|Updated Oct 15, 2018
Search Tags:#github#release notes#commit analysis#software documentation#pr integration
One-click install
npx skills add https://github.com/music-brain88/dotfiles --skill release-note-music-brain88
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: release-note
Source: https://github.com/music-brain88/dotfiles/tree/main/.config/skills/release-note
Command: npx skills add https://github.com/music-brain88/dotfiles --skill release-note-music-brain88

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires gh, git, and includes scripts (resource) components.

What problem does it solve?

This Skill addresses the issue of creating comprehensive release notes for GitHub repositories by incorporating details from pull requests.

Core Features & Use Cases

  • PR Integration: Extracts information from pull requests to enrich release notes.
  • Automated Drafting: Generates or updates release notes based on commit history and PR details.
  • Use Case: Ideal for teams that need to maintain detailed release notes to document new features, bug fixes, and breaking changes in their GitHub projects.

Quick Start

Run the release-note skill with the tag name 'v1.0.0' to update the release notes for the latest release.

Frequently Asked Questions about release-note

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

FAQPage Schema
How do I generate GitHub release notes from pull request details?▼

To generate GitHub release notes from pull request details, you can use a shell scripting tool that retrieves PR data via the GitHub API and automatically populates the release draft with associated feature and bug fix information.

What is the best way to automate release note creation for software documentation?▼

Automating release note creation for software documentation is best handled by extracting commit history and PR integration details directly from your version control platform, ensuring new features and breaking changes are captured comprehensively.

Do I need GitHub CLI and git installed to extract PR information for release drafting?▼

Yes, you need both the GitHub CLI (gh) and git installed, as these dependencies provide the necessary command-line access to extract pull request information and automate your release drafting workflow.

Can I update existing GitHub release notes with commit analysis after tagging a release?▼

Yes, you can update existing GitHub release notes by running a script against a specific tag name like 'v1.0.0', which uses commit analysis to enrich the latest release documentation with missing PR details.

Why does my automated release note drafting miss breaking changes from merged pull requests?▼

Automated release note drafting might miss breaking changes if the associated pull requests lack clear descriptions, as the script relies on extracting existing PR details and commit history directly from GitHub API responses.

Related Skills

Explore More Software Engineering Skills→
helderbertohelderberto
114

amend-push

Amend the previous commit and push changes to a remote repository.

Community
Basic
JansenAnalyticsJansenAnalytics
5

release-manager

Automate changelog generation, version bumps, and GitHub releases via CLI.

Community
Intermediate
k97k97
4

gen-release-notes

Generate structured release notes from git commit history and pull request data.

Community
Advanced
TobiasGoetzTobiasGoetz

commit

Generate conventional commit messages and PR titles for Release Please.

Community
Intermediate