ship

name	ship
description	Use when finishing a feature or fix and ready to release — runs lint, tests, docs check, personal data audit, version bump, changelog, commit, tag, merge to main, and push to origin.

/ship — Pre-Release Checklist and Push

Overview

Cascade checklist that validates, versions, commits, and pushes a Ferry release. Works from main (direct push) or from a feature branch (merge to main, then push).

CRITICAL: Never Switch Branches

NEVER create a branch, switch branches, or run git checkout/git switch during /ship.

This is a production machine running Dokku + Cloudflare Tunnel. Branch switches can destroy gitignored runtime config files (like tunnels/providers/cloudflare/config.yml), causing cascading Docker failures that take the entire tunnel offline.

• If on main: ship directly (commit, tag, push). No branch needed.
• If on a feature branch: ship from there (commit, merge to main, tag, push).
• If the user hasn't already created a feature branch, do NOT create one. Just ship from wherever you are.

When to Use

• After completing a feature, fix, or improvement
• When the user says "ship it", "push", "release", or invokes /ship
• Before any code reaches the public GitHub repo

Workflow

From main (most common):

main → lint → test → docs → audit → version → changelog → commit → tag → push

From a feature branch (only if already on one):

feature-branch → lint → test → docs → audit → version → changelog → commit → merge main → tag → push

Steps

1. Branch Check

Check which branch you're on. Do NOT switch or create branches.

current=$(git branch --show-current)
git status --short  # must be clean or have only expected changes

If on main: proceed directly — steps 9 (merge) and 12 (cleanup) are skipped. If on a feature branch: the full flow including merge applies.

2. Lint

make lint

Must exit 0. Also run:

bash -n ferry.sh

3. Tests

Run all test suites and confirm pass counts:

bats test/unit/
bats test/integration/
bats test/generators/all_generators.bats

All must pass. Report total count. If Docker tests are included (runtime HTTP 200), they may take a few minutes — run them.

4. Docs Check

Verify version consistency:

• FERRY_VERSION in ferry.sh (line 9) matches the intended release version
• CHANGELOG.md has an entry for this version at the top
• No stale version references in README or docs

grep 'FERRY_VERSION=' ferry.sh | head -1
head -6 CHANGELOG.md

5. Personal Data Audit

CRITICAL for this public repo. Scan staged/changed files for personal data:

git diff --cached --name-only | xargs grep -il 'gastonmorixe\.com\|kitekite\|bedhero\|gooseup\|ledsport\|multifiesta\|shieldsdev\|rails-fields\|5ac59747' 2>/dev/null

Also check for:

• Real Cloudflare tunnel IDs, account IDs, zone IDs
• API tokens or credentials
• Real domain names (except in the GitHub repo URL gastonmorixe/ferry which is intentional)
• Private IPs or hostnames

If anything found, STOP and ask the user before proceeding.

6. Version Bump

If not already bumped, determine the next version:

• Patch (0.6.x): bug fixes, small improvements, branding changes
• Minor (0.x.0): new features, new generators, new commands
• Major (x.0.0): breaking changes

Update FERRY_VERSION in ferry.sh script. Always run date -Iseconds for timestamps.

7. Changelog

Add entry at top of CHANGELOG.md with:

• Version and date
• Sections: Added / Changed / Fixed (as applicable)
• Concise but specific descriptions of what changed

8. Commit

Stage specific files (never git add -A):

git add ferry.sh CHANGELOG.md [other changed files...]

Commit with a detailed message using heredoc:

git commit -m "$(cat <<'EOF'
Ferry v{VERSION} — {one-line summary}

{detailed description of changes}
EOF
)"

9. Merge to Main (feature branch only — skip if on main)

Only if you're on a feature branch. If on main, skip to step 10.

git checkout main
git merge --no-ff {feature-branch} -m "Merge {feature-branch}: {summary}"

If conflicts, stop and resolve with user.

10. Tag

git tag v{VERSION}

11. Push

git push origin main
git push origin v{VERSION}

12. Cleanup (feature branch only — skip if shipped from main)

Ask user if they want to delete the feature branch:

git branch -d {feature-branch}

Checklist Summary (for quick reference)

Step	Command	Must pass
Branch	git branch --show-current	Note which branch (do NOT switch)
Lint	make lint	exit 0
Syntax	bash -n ferry.sh	exit 0
Unit tests	bats test/unit/	all pass
Integration	bats test/integration/	all pass
Generator	bats test/generators/	all pass
Version	grep FERRY_VERSION ferry.sh	matches release
Changelog	head CHANGELOG.md	has version entry
Data audit	grep for personal data	nothing found
Commit	git commit	clean message
Merge (feature branch only)	git merge --no-ff	no conflicts
Tag	git tag v{VERSION}	created
Push	git push origin main	success
Push tag	git push origin v{VERSION}	success

Red Flags — STOP

• Creating or switching branches — NEVER do this, it can destroy runtime config and take the tunnel offline
• Personal data in staged files
• Tests failing
• Lint errors
• Version mismatch between ferry.sh script and changelog
• Uncommitted changes on main before merge
• Force push needed (never force push to main)