changeset-pr

Create and verify `.changeset/*.md` files for pull requests in a monorepo.

2.6k|423|Updated Oct 24, 2020
One-click install
npx skills add https://github.com/module-federation/core --skill changeset-pr
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: changeset-pr
Source: https://github.com/module-federation/core/tree/main/.codex/skills/changeset-pr
Command: npx skills add https://github.com/module-federation/core --skill changeset-pr

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires python3, and includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill automates the creation and verification of .changeset/*.md files, ensuring that changes to publishable packages are correctly documented for releases. It helps maintain consistency and accuracy in the release process.

Core Features & Use Cases

  • Changeset Creation: Generates or updates .changeset/*.md files based on the live branch diff.
  • Scope Verification: Determines the correct package scope and release type (patch, minor, major) by analyzing code changes.
  • Validation: Validates the changeset against repository-specific configurations and ensures it aligns with branch changes.
  • Use Case: When a developer finishes work on a new feature for a specific package, this Skill can be used to create the necessary changeset file, ensuring the release notes accurately reflect the changes and the correct version bump is proposed.

Quick Start

Use the changeset-pr skill to create or update the correct changeset for this branch and verify its scope.

Frequently Asked Questions about changeset-pr

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

FAQPage Schema
How do I automate changeset creation for pull requests in a monorepo?

To automate changeset creation for monorepo pull requests, this skill analyzes code diffs to generate or update `.changeset/*.md` files. It determines the correct package scope and release type, ensuring publishable packages have accurate version bump metadata.

What is a changeset file and when do I need it for release management?

A changeset file documents changes to publishable packages for release management. You need it when modifying a package in a monorepo to ensure the correct version bump and release notes are proposed during the automated release process.

How do I verify the package scope and release type in an existing changeset?

You can verify changeset scope and release type by analyzing the branch code diff against repository-specific configurations. This skill validates if the existing changeset accurately reflects the modified publishable packages and proposes corrections if needed.

Do I need Python to generate changeset files for versioning?

Yes, Python is required as a dependency to run the scripts that generate and verify changeset files. The environment needs Python installed to execute the automation logic for determining package scopes and release types.

What happens if a pull request is missing a changeset for a publishable package?

If a pull request is missing a changeset for a publishable package, this skill detects the gap by analyzing the diff. It then creates the necessary `.changeset/*.md` file to ensure the release metadata accurately reflects the code changes.