generate-upgrade-notes

Generate structured upgrade notes from pull request diffs and commit messages.

349|98|Updated Feb 1, 2018
One-click install
npx skills add https://github.com/shopsys/shopsys --skill generate-upgrade-notes
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: generate-upgrade-notes
Source: https://github.com/shopsys/shopsys/tree/main/.agents/skills/generate-upgrade-notes
Command: npx skills add https://github.com/shopsys/shopsys --skill generate-upgrade-notes

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill automates the generation of structured upgrade notes for pull requests, ensuring consistency and saving developers time on documentation.

Core Features & Use Cases

  • Automated Analysis: Analyzes code changes within a pull request to identify breaking changes and feature movements.
  • Structured Output: Generates upgrade note files in a predefined format, ready for release notes.
  • Use Case: When submitting a complex backend change via a pull request, use this Skill to automatically generate the necessary upgrade notes, detailing any breaking changes or new features for the next release.

Quick Start

Use the generate-upgrade-notes skill to analyze the current branch changes and generate upgrade notes.

Frequently Asked Questions about generate-upgrade-notes

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

FAQPage Schema
How do I automatically generate upgrade notes from a pull request?

To automatically generate upgrade notes from a pull request, you need a tool that analyzes code diffs and commit messages. This Skill identifies feature movements, modifications, and backward-incompatible changes to create structured documentation files for your release.

What is the best way to document backward-incompatible changes in a pull request?

Documenting backward-incompatible changes in a pull request requires analyzing code diffs to detect breaking modifications. This Skill automates that process by evaluating your changes and producing organized upgrade note files that detail these breaking changes for the next release.

How do code diff analyzers identify feature movements for release documentation?

Code diff analyzers identify feature movements by examining the modifications within a pull request. This Skill specifically evaluates code changes and commit messages to detect when features are moved or altered, organizing the results into structured documentation files.

Can I use automated upgrade notes generation for package-first development?

Yes, you can use automated upgrade notes generation for package-first development. This Skill adheres to package-first development principles and specific file naming conventions while analyzing pull request changes to generate structured documentation.

Do I need subagents to fetch PR data for generating release notes?

Yes, you need subagents to fetch PR data for generating release notes in this workflow. The Skill requires subagents to retrieve pull request information and analyze code changes before creating the structured upgrade note files.

What limitations exist when automating pull request documentation with code analysis?

A limitation of automating pull request documentation with code analysis is the dependency on subagents for fetching PR data and evaluating changes. Additionally, the output strictly requires specific file naming conventions and adherence to package-first development principles to function correctly.