mcpField
C
changeset-validation

changeset-validation

github.com/openaiTesting & quality4.0k128 installsUpdated 1w ago
Repository

About changeset-validation

changeset-validation is a skill for checking whether changesets reflect package changes and repository rules. It shares validation logic between local Codex reviews and GitHub Actions, using a generated prompt and structured JSON verdict.

Key features

  1. 01Generate a changeset validation prompt
  2. 02Check changes against bump types
  3. 03Return a JSON verdict
  4. 04Support local and CI workflows
  5. 05Guide edits to existing changesets

Use cases

  1. 01Check a changeset before submitting
  2. 02Generate a structured CI verdict
  3. 03Rewrite an existing changeset for the primary change

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/openai/openai-agents-js --skill changeset-validation

After installing, type/changeset-validationin Claude Code to confirm it loaded.

Bundled files

References and scripts installed along with SKILL.md.

agents/
openai.yaml
references/
validation-prompt.md
scripts/
changeset-assign-milestone.mjs
changeset-prompt.mjs
changeset-prompt.test.mjs
changeset-validation-result.mjs
run-fixtures.sh

Details

From the project README

Changeset Validation

Overview

This skill validates whether changesets correctly reflect package changes and follow the repository rules. It relies on the shared prompt in references/validation-prompt.md so local Codex reviews and GitHub Actions share the same logic. Experimental or preview-only feature additions that are explicitly labeled as such in the diff may remain a patch bump when they do not change existing behavior. Major bumps are only allowed after the first major release; before that, do not use major bumps for feature-level changes.

Quick start

Local (Codex-driven):

  1. Run: 
    pnpm changeset:validate-prompt
  2. Apply the rules from references/validation-prompt.md to the generated prompt.
  3. Respond with a JSON verdict containing ok/errors/warnings/required_bump (English-only strings).

CI (Codex Action):

  1. Run: 
    pnpm changeset:validate-prompt -- --ci --output .github/codex/prompts/changeset-validation.generated.md
  2. Use openai/codex-action with the generated prompt and JSON schema to get a structured verdict.

Workflow

  1. Generate the prompt context via pnpm changeset:validate-prompt.
  2. Apply the rules in references/validation-prompt.md to judge correctness.
  3. Provide a clear verdict and required bump (patch/minor/major/none).
  4. If the changeset needs edits, update it and re-run the validation.

Branch-level changeset rule (do not skip)

  • If any .changeset/*.md file is already present in the current branch diff, treat it as the active changeset. Do not add a new changeset file.
  • Instead, update the existing changeset file by rewriting its summary to reflect the primary change relative to main. Do not try to capture every incremental update.
  • Keep the summary at one line; replace the line as needed rather than appending. If you must include multiple points, compress them into a single line.

Shared source of truth

  • Keep the prompt file as the single source of validation rules.
  • Keep the script lightweight: it should only gather context and emit the prompt.

Resources

  • references/validation-prompt.md

Comments

Markdown supported