skills.rest
compozy
compozyOFFICIAL
Explore all skills by this author →
Website𝕏@compozyaiGitHub

ship-pr

Generate documentation impact notes, release notes, and a GitHub PR description, then commit and open the PR.

182|8|Updated Apr 4, 2026
Search Tags:#pull request#release notes#commit conventions#code review automation#github gh#qa evidence#documentation impact
One-click install
npx skills add https://github.com/compozy/agh --skill ship-pr-compozy
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: ship-pr
Source: https://github.com/compozy/agh/tree/main/.agents/skills/ship-pr
Command: npx skills add https://github.com/compozy/agh --skill ship-pr-compozy

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires gh, pr-release, compozy, skeeper, commitlint, and includes references (resource) components.

What problem does it solve?

Ship-ready PRs often miss critical wrap-up work like accurate doc impact, consistent release notes, a complete PR description, convention-compliant commits, and a properly opened GitHub pull request.

Core Features & Use Cases

  • Explore PR impact end-to-end: detects what changed across docs/site/README and related artifacts, then aggregates impact by area.
  • Generate release notes: uses pr-release when available, otherwise builds an inline conventional-commit changelog from git history.
  • Author a complete PR description: fills Summary, Changes, Release Notes, and (when present) QA and evidence details from QA artifacts; then commits staged changes using commitlint conventions.
  • Open the PR and optionally start review watch: creates the PR via gh CLI and can launch compozy CodeRabbit review-watch when compozy is installed.

Quick Start

Run the ship-pr skill on a branch with finished, implementation-complete changes ready to be shipped, and let it generate the PR description and open the GitHub pull request automatically.

Frequently Asked Questions about ship-pr

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

FAQPage Schema
How do I generate a complete GitHub pull request description with release notes automatically?▼

To generate a complete GitHub pull request description, this skill aggregates changes from your git history and populates Summary, Changes, and Release Notes sections, then commits staged changes using commitlint conventions before opening the PR with gh.

How do I update documentation and CHANGELOG files when shipping a finished feature?▼

To update documentation when shipping a finished feature, this skill detects changes across docs, site, README, and CHANGELOG artifacts, then aggregates the documentation impact by area into the final PR description.

Do I need the gh CLI installed to automate opening a pull request?▼

Yes, you need the gh CLI installed and a valid git working tree to automate opening a pull request, because this skill relies on gh for publishing the PR directly from your branch.

Can I use pr-release to build conventional-commit changelogs for my pull request?▼

Yes, this skill uses pr-release to generate release notes when available, and otherwise falls back to building an inline conventional-commit changelog directly from your git history.

What is the best way to include QA evidence in my code review automation workflow?▼

The best way to include QA evidence is to let this skill detect QA artifacts in your working tree and automatically populate the QA section of your PR description before optionally launching review watch.

Can I trigger CodeRabbit review automation when opening a GitHub pull request?▼

Yes, you can trigger CodeRabbit review automation when opening a GitHub pull request, because this skill optionally launches compozy CodeRabbit review-watch when compozy is installed.

Related Skills

Explore More Software Engineering Skills→
LAF-USLAF-US

yeet

Validate scope, stage, commit, push, and open a draft PR.

Official
Intermediate
ilandahanilandahan
9

code-review

Review pull requests for security, TDD, and code quality standards.

Community
Advanced
cq112233cq112233
21

chinese-commit-conventions

Configures commitlint, husky, and lint-staged for Chinese-localized Conventional Commits.

Community
Intermediate
cenk1cenk2cenk1cenk2
2

github-pr

Analyze branch commits and diffs to draft GitHub pull request titles and descriptions.

Community
Intermediate