s-ship

name	s-ship
description	Ship workflow - sync, test, version bump, commit, push, and create PR in one command

/s:ship - Ship Workflow

One command to go from local branch to open PR. Handles sync, tests, versioning, commit, push, and PR creation.

Prerequisites

• You must be on a feature branch (not main or master)
• All work should be committed or staged
• Tests should be passing locally before running this skill

Instructions

Step 1: Pre-flight Checks

1. Run git status to check for uncommitted changes
2. If there are uncommitted changes, warn the user:
   • Show the list of modified/untracked files
   • Ask: "You have uncommitted changes. Should I commit them first, or do you want to handle this manually?"
   • If user says commit, create a conventional commit with appropriate message
3. Verify you are NOT on main or master branch. If you are, stop and suggest creating a feature branch first
4. Check that a remote named origin exists: git remote get-url origin

Step 2: Sync with Main Branch

1. Fetch latest from origin: git fetch origin
2. Rebase onto main: git rebase origin/main
3. If rebase conflicts occur:
   • Show the conflicting files
   • Ask user how to resolve
   • Do NOT force-continue or abort without user input
   • After resolution, continue rebase: git rebase --continue

Step 3: Run Full Test Suite

1. Detect the project test runner:
   • If package.json exists with scripts.test: run npm test
   • If Makefile exists with test target: run make test
   • If pytest.ini or pyproject.toml with pytest config: run pytest
   • If Cargo.toml exists: run cargo test
   • If none found, check for any test files and suggest a runner
2. STOP if tests fail. Do not proceed to shipping.
   • Show the failure output clearly
   • Suggest: "Fix the failing tests, then run /s:ship again"
   • Exit the skill

Step 4: Version Bump (if applicable)

1. Check if a VERSION file exists in the project root
2. If it exists, read the current version (expected format: MAJOR.MINOR.PATCH)
3. Bump based on flag or default:
   • Default (no flag): bump PATCH (e.g., 1.2.3 -> 1.2.4)
   • If user passed --minor: bump MINOR (e.g., 1.2.3 -> 1.3.0)
   • If user passed --major: bump MAJOR (e.g., 1.2.3 -> 2.0.0)
4. Write the new version back to VERSION

Step 5: Update CHANGELOG (if applicable)

1. Check if CHANGELOG.md exists
2. If it exists, add a new entry at the top under ## Unreleased or create a new version section:

   ## [X.Y.Z] - YYYY-MM-DD
   
   ### Changes
   - {summary of changes from git log since last tag}
   

3. Extract change summaries from git log --oneline since the last tag or last CHANGELOG entry

Step 6: Create Commit

1. Stage all changes: version bump, changelog updates, any remaining files
2. Create a commit with conventional message format:
   • Detect the primary change type from recent commits and diff:
     • feat: for new features
     • fix: for bug fixes
     • chore: for maintenance
     • refactor: for refactoring
     • docs: for documentation
     • test: for test-only changes
   • Use the branch name or latest commit message to derive a concise description
   • Example: feat: add user authentication flow

Step 7: Push to Remote

1. Push the branch with upstream tracking: git push -u origin HEAD
2. If push is rejected (e.g., force push needed), warn the user and ask for confirmation before proceeding

Step 8: Create Pull Request

1. Use gh pr create to open a PR:
   • Title: derived from the latest commit message or branch name (keep under 70 chars)
   • Body: structured summary using this format:

     ## Summary
     - {bullet point summary of changes}
     
     ## Test Results
     - All tests passing ({test count} tests)
     - {any notable test coverage info}
     
     ## Checklist
     - [ ] Tests pass
     - [ ] Code reviewed
     - [ ] Documentation updated
     - [ ] No breaking changes (or documented)
     

2. If gh CLI is not available, provide the manual PR URL and instructions

Step 9: Update State

1. Update .planning/STATE.md if it exists:
   • Add a decision entry: | {DATE} | Shipped: {branch-name} | PR #{number} created |
   • Update status if this completes a phase

Step 10: Next Steps

Output to the user:

Shipped successfully!
- Branch: {branch-name}
- PR: {pr-url}
- Version: {version} (if applicable)

Next: Run `/s:compound` to capture learnings from this work.

Flags

Flag	Effect
--minor	Bump minor version instead of patch
--major	Bump major version instead of patch
--draft	Create PR as draft
--no-version	Skip version bump even if VERSION exists

Error Handling

• Tests fail: Stop immediately, show output, suggest fix
• Rebase conflicts: Pause for user resolution
• Push rejected: Warn and ask before force-pushing
• No remote: Suggest adding a remote first
• gh not installed: Provide manual PR URL