record-upgrade-instructions

Record structured upgrade instructions for breaking changes in the Prisma Next repository.

47.5k|2.5k|Updated Jun 20, 2019
One-click install
npx skills add https://github.com/prisma/prisma --skill record-upgrade-instructions
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: record-upgrade-instructions
Source: https://github.com/prisma/prisma/tree/main/skills-contrib/record-upgrade-instructions
Command: npx skills add https://github.com/prisma/prisma --skill record-upgrade-instructions

SYSTEM DOCUMENTATION & REQUIREMENTS

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

What problem does it solve?

This skill solves the challenge of keeping downstream consumers and extension authors in sync with breaking changes in the Prisma Next framework by automating the creation of migration instructions.

Core Features & Use Cases

  • Automated Migration Tracking: Guides developers through recording necessary code translations for breaking changes.
  • Cross-Audience Support: Manages separate upgrade paths for end-users and extension authors to ensure compatibility.
  • Validation by Execution: Ensures that recorded instructions actually fix the substrate and pass the test suite before the PR is merged.

Quick Start

Use the record-upgrade-instructions skill to generate the required migration entries for the breaking changes in the current PR branch.

Frequently Asked Questions about record-upgrade-instructions

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

FAQPage Schema
How do I automate Prisma breaking-change migrations for downstream code?

To automate Prisma breaking-change migrations, you can record structured upgrade instructions that guide downstream consumers through necessary code translations when framework changes impact examples or extension packages.

What is the best way to track breaking changes in Prisma Next for extension authors?

Tracking breaking changes in Prisma Next involves recording version-based transition instructions that manage separate upgrade paths, ensuring extension authors can maintain compatibility with the latest framework modifications.

How do I validate automated migration instructions before merging a Prisma PR?

Validating automated migration instructions requires executing the repository test suite to ensure the recorded code translations actually fix the substrate and pass all tests before the pull request is merged.

Do I need TypeScript to record upgrade instructions for Prisma Next?

Yes, recording upgrade instructions for Prisma Next requires a TypeScript environment, specifically using the tsx dependency to execute the scripts that generate and validate the structured migration entries.

When do I need to record structured upgrade instructions for Prisma framework modifications?

You need to record structured upgrade instructions when modifying Prisma framework code in a pull request that introduces breaking changes affecting downstream examples or extension packages.

How does the version-based transition directory structure work for Prisma migrations?

The version-based transition directory structure organizes recorded migration instructions by framework version, ensuring downstream consumers and extension authors follow the correct upgrade path for their specific codebase.