ship

Merge reviewed pull requests with security checks and squash-merge discipline.

Updated Mar 2, 2022
One-click install
npx skills add https://github.com/ysuurme/azure_hello_world --skill ship-ysuurme
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: ship
Source: https://github.com/ysuurme/azure_hello_world/tree/main/.agents/skills/ship
Command: npx skills add https://github.com/ysuurme/azure_hello_world --skill ship-ysuurme

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill prevents insecure or incomplete merges by enforcing required security gates and ensuring post-merge knowledge persistence in CONTEXT.md.

Core Features & Use Cases

  • Pre-merge security gates: Runs a module map validation, sandboxing verification, and supply-chain review before allowing a merge.
  • Controlled merge mechanics: Enforces squash-merge discipline using the GitHub CLI and branch cleanup.
  • Traceability + knowledge updates: Validates Closes #N, auto-closes the linked issue on merge, and updates CONTEXT.md and .out-of-scope.md with lessons learned and deferred work.
  • Use Case: After you’ve finished resolving all review BLOCKs and included Closes #N in the PR body, this Skill helps ensure the PR can be merged without missing documentation updates or security checks.

Quick Start

Use the ship skill to merge the reviewed PR with squash discipline, validate security gates, update CONTEXT.md and .out-of-scope.md, and ensure the linked issue is closed via Closes #N.

Frequently Asked Questions about ship

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

FAQPage Schema
How do I enforce security gates before a pull request merge?

To enforce security gates before a pull request merge, you need automated checks for module map validation, sandboxing verification, and supply-chain dependency review. This ensures reviewed PRs meet mandated security standards prior to integration.

How do I squash merge a pull request and delete the branch using gh CLI?

To squash merge a pull request and delete the branch using gh CLI, execute a squash merge command that integrates changes and automatically removes the source branch. This maintains a clean commit history and repository structure.

How do I ensure traceability when merging a GitHub pull request?

To ensure traceability when merging a GitHub pull request, include a 'Closes #N' directive in the PR body. This automatically closes the linked issue upon merge, maintaining full traceability between the resolved work and the original request.

How do I update CONTEXT.md and .out-of-scope.md after a PR merge?

To update CONTEXT.md and .out-of-scope.md after a PR merge, persist architectural lessons learned and document deferred work. This captures project knowledge and evolving scope boundaries directly within the repository documentation.

Do I need gh CLI to automate pull request merges with branch deletion?

Yes, you need gh CLI access to automate pull request merges with branch deletion. The CLI provides the necessary git-based diff checks and squash merge execution required to enforce controlled merge mechanics and branch cleanup.

What is the best way to persist architectural lessons after merging a reviewed PR?

The best way to persist architectural lessons after merging a reviewed PR is to mandate post-merge updates to documentation files. Updating CONTEXT.md and .out-of-scope.md ensures valuable project knowledge and deferred work items are retained.