ship-workflow

Verify changes, update documentation, commit, and prepare GitHub pull requests.

11|Updated Jul 2, 2026
One-click install
npx skills add https://github.com/romiluz13/auto-pi --skill ship-workflow-romiluz13
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: ship-workflow
Source: https://github.com/romiluz13/auto-pi/tree/main/skills/ship-workflow
Command: npx skills add https://github.com/romiluz13/auto-pi --skill ship-workflow-romiluz13

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill prevents incomplete or unsupported software changes from being shipped by enforcing evidence-based verification, documentation review, clean commits, and conditional GitHub delivery.

Core Features & Use Cases

  • Evidence-Based Verification: Audits prior claims, runs the project's relevant checks, and requires recorded command output before advancing.
  • Diff-Driven Documentation: Evaluates whether business, technical, or audit documentation needs updates based on the change.
  • Controlled Delivery: Creates a clean conventional commit, optionally pushes a branch, opens a pull request, and tracks CI status without pushing directly to main.
  • Use Case: After implementing a feature, use this workflow to verify the change, update only necessary documentation, commit it safely, and optionally prepare a GitHub pull request.

Quick Start

Use the ship workflow to verify the current changes, update necessary documentation, create a commit, and prepare a pull request if appropriate.

Frequently Asked Questions about ship-workflow

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

FAQPage Schema
How do I verify code changes before creating a git commit?

To verify code changes before a git commit, you must run the project's relevant checks and capture the command output. This evidence-based verification ensures unsupported software changes are not committed without independent validation.

What is the best way to prepare a pull request after finishing a bug fix?

The best way to prepare a pull request after a bug fix is to use a controlled delivery workflow that creates a conventional commit, pushes a branch, and tracks CI status. This prevents pushing directly to main.

Does this shipping workflow require documentation updates for every commit?

No, the shipping workflow uses diff-driven evaluation to determine if business, technical, or audit documentation needs updates. It only requires modifying documentation when the specific code change dictates it.

Can I push directly to the main branch with this software delivery process?

No, you cannot push directly to the main branch with this software delivery process. It enforces branch-based GitHub workflows, optionally pushing a branch and opening a pull request to track CI status safely.

How do I ensure secrets are protected when pushing code to GitHub?

To ensure secrets are protected when pushing code to GitHub, this workflow applies secret protection checks during the controlled delivery phase. It prevents sensitive data from being included in conventional commits or branch pushes.

When do I need to track CI status during a software delivery workflow?

You need to track CI status during a software delivery workflow when opening a GitHub pull request. This monitoring happens after branch-based delivery to ensure continuous integration passes before merging changes.