custom-gh-pr-release

Creates or updates a develop-to-main release pull request with audience-split release notes and caution checks.

1|Updated Apr 3, 2021
One-click install
npx skills add https://github.com/NaoyaMiyagawa/dotfiles --skill custom-gh-pr-release-naoyamiyagawa
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: custom-gh-pr-release
Source: https://github.com/NaoyaMiyagawa/dotfiles/tree/main/.ai/skills/custom-gh-pr-release
Command: npx skills add https://github.com/NaoyaMiyagawa/dotfiles --skill custom-gh-pr-release-naoyamiyagawa

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Writing release pull requests that merge develop into main is tedious: you must review every merged PR, translate technical changes into language non-developers can read, and remember to check for risky changes like new environment variables or breaking API modifications. This Skill automates that entire workflow. ## Core Features & Use Cases - Automated change collection: Builds the change list from git log origin/main..origin/develop and enriches it with PR titles and bodies via gh pr view. - Audience-split release notes: Generates a description with separate User-facing and Internal changes sections, grouped by category, so product managers, designers, and customer success teams can read what matters to them. - Release caution checks: Verifies new environment keys, external-app impact, DB migrations, and feature flags against the actual diff, and reports each result even when it is None. - Use Case: Before a weekly production deploy, ask for a release PR and receive a ready-to-review develop-to-main PR with complete release notes and a caution checklist, or have the existing open release PR updated in place. ## Quick Start Create a release PR from develop to main with release notes and caution checks for this repository.

Frequently Asked Questions about custom-gh-pr-release

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

FAQPage Schema
How do I create a release PR from develop to main on GitHub?

Run git fetch, collect changes with git log origin/main..origin/develop, enrich them using gh pr view, then create the PR with base main and head develop via the GitHub CLI. This Skill automates that full workflow including the release notes body.

How to write release notes that non-developers can understand?

Split the notes into User-facing changes and Internal changes sections. Write user-facing bullets in plain language leading with the outcome, group items under category headings, and keep internal refactors and dependency upgrades in a separate terse section.

What should I check before merging a release pull request?

Check for new or changed environment keys in .env.example, external-app impact on public APIs and webhooks, database migrations, queue or scheduled-job changes, and feature flags. Verify each against the actual diff rather than guessing from PR titles.

Does this work if a release PR is already open?

Yes. If a develop-to-main PR is already open, the Skill updates its body with gh pr edit instead of creating a duplicate PR, keeping the existing discussion and review history intact.

What tools are required to generate a GitHub release PR automatically?

You need git for fetching and diffing branches and the GitHub CLI (gh) for viewing PR details, listing previous release PRs, and creating or editing the release pull request. No additional scripts or packages are required.