upgrade-notes-analyzer

Analyze pull request diffs to detect breaking changes and feature movements.

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

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill automates the analysis of pull request differences to identify and categorize breaking changes, feature movements, and scope shifts, streamlining the release and upgrade process.

Core Features & Use Cases

  • Breaking Change Detection: Identifies removed methods, modified constructors, and removed GraphQL fields.
  • Feature Movement Tracking: Differentiates between actual removals and features moved from project-base to packages.
  • Scope Determination: Infers whether changes affect the backend, storefront, or both.
  • Use Case: Before merging a large PR, use this Skill to generate a clear, actionable summary of all potential breaking changes for the release notes, ensuring a smoother upgrade for users.

Quick Start

Analyze the provided PR diff content and metadata to identify breaking changes and feature movements.

Frequently Asked Questions about upgrade-notes-analyzer

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

FAQPage Schema
How do I detect breaking changes in a pull request diff?

To detect breaking changes in a pull request, analyze the PR diff and metadata to identify removed methods, modified constructors, and removed GraphQL fields. This process automatically categorizes potential issues for actionable upgrade notes.

How do I track feature movements from project-base to packages?

Tracking feature movements from project-base to packages involves analyzing PR diffs to differentiate between actual code removals and structural migrations. This determines if a feature was relocated rather than deleted.

Can I automatically determine if PR changes affect the backend or storefront?

Yes, you can determine the scope of PR changes by analyzing the diff content. This analysis infers whether the modifications affect the backend, the storefront, or both, providing clear impact boundaries for upgrade notes.

What is the best way to generate actionable upgrade notes from a GitHub PR?

The best way to generate actionable upgrade notes from a GitHub PR is to automate the analysis of pull request differences. This identifies breaking changes, feature movements, and scope shifts to streamline the release process.

Does this breaking change analyzer work with GraphQL schema modifications?

Yes, this breaking change analyzer works with GraphQL schema modifications by detecting removed GraphQL fields during the PR diff analysis. It categorizes these schema alterations to ensure they are documented in the upgrade notes.

What are the limitations of automated PR analysis for release notes?

Automated PR analysis for release notes relies strictly on the provided pull request diff and metadata. It cannot infer external context or undocumented dependencies, meaning its scope determination is limited strictly to the submitted code changes.