agentleFS
hiteshbandhuhiteshbandhu/skills-i-use/skills/ship-check/SKILL.md

ship-check

Skill1 starsChanged 5 months agoMITView on GitHub

Pre-ship gate before commit or push — runs lint, typecheck, tests, build, secret scan, and git diff review, then outputs a READY/BLOCKED verdict with a proposed commit message. Never commits without explicit user confirmation. Triggers on "ship check", "ready to commit", "pre-push check", "commit and push", "ship this", "can I push".

  • Reads credentials

19 other projects use a version of this.

Adopted by

Most recently taken up by

Used with

Projects with it also use review.

Other files people use alongside this one.

Files found in the same public projects as a version of this one, more often than they turn up anywhere else. Each project counts once, large collections count for less, and this file's own repository is left out.
  • SentrySkill

    review

    Fixture review skill.

    Also in 3 projects that use this

The file

We split this skill into the rules it gives an agent

9 rules. 0 are common, 7 are distinctive, and 2 are very specific to this project.

  • 0

    Common

    Most of the 18 edited versions we read keep these.

  • 7

    Distinctive

    This author's own choices. Worth a look.

  • 2

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Run automated checks + human-readable diff review before any commit or push.

    line 12
  2. Very specific:

    Scripts: read scripts/ship-check.sh before running.

    line 22
  3. Distinctive:

    Run in parallel where possible:

    line 44
  4. Very specific:

    If scripts/ship-check.sh is not in cwd, locate it from the skill folder or run equivalent checks manually per checklist.md.

    line 62
  5. Distinctive:

    Read checklist.md. Manually inspect the diff for:

    line 71
  6. Distinctive:

    Use conventional commits unless the repo uses something else.

    line 92
  7. Distinctive:

    Ask: "Commit?" — only proceed on yes

    line 121
  8. Distinctive:

    Ask: "Push?" — only if user wants push, and only after successful commit

    line 122
  9. Distinctive:

    If BLOCKED, list fixes needed.

    line 124

“Common” is measured: kept by at least 6 in 10 of the 18 edited versions of this file we could read. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

Ship Check — Pre-Ship Gate

Run automated checks + human-readable diff review before any commit or push. Never commit or push unless the user explicitly confirms after seeing the report.

Works with any coding agent with shell access.

Supporting files:

  • checklist.md — manual gate items
  • report-template.md — output format
  • scripts/ship-check.sh — automated checks

Scripts: read scripts/ship-check.sh before running. It executes project lint/test/build commands — review what it will run in this repo. Double-check every time.

Output: {SKILL_OUTPUT_DIR}/ship-check/ — see ../OUTPUT.md


Step 0 — Scope

Infer or ask:

SettingDefault
Skip buildno — unless user says "skip build"
Skip testsno — unless user says "skip tests" or "quick check"
Commit afteronly if user confirms after report
Push afteronly if user explicitly asks after commit succeeds

Step 1 — Collect State

Run in parallel where possible:

git status
git diff
git diff --cached
git branch --show-current
git log -3 --oneline

Then run automated checks:

bash scripts/ship-check.sh
# Optional: SHIP_CHECK_STRICT=1 bash scripts/ship-check.sh
# Flags: --skip-build --skip-tests

If scripts/ship-check.sh is not in cwd, locate it from the skill folder or run equivalent checks manually per checklist.md.

Review script output: lines prefixed PASS|, WARN|, FAIL|, DIFF_STAT|, SUMMARY|.


Step 2 — Diff Review

Read checklist.md. Manually inspect the diff for:

  • Scope creep unrelated to the task
  • Secrets, tokens, .env files
  • Debug logging left behind
  • Breaking changes without migration notes

Assign verdict:

VerdictWhen
BLOCKEDAny `FAIL` from script, secrets in diff, or broken build/tests
READY WITH WARNINGSWarnings only, or user waived a check
READYAll checks pass, diff looks intentional

Step 3 — Draft Commit Message

Analyze the full diff. Match the repo's existing commit style (git log -5).

Use conventional commits unless the repo uses something else. Focus on why, not just what.


Step 4 — Write Report

Fill report-template.md.

Path: {output_dir}/ship-check-YYYY-MM-DD-HHMM.md

Update {output_dir}/index.md:

# Ship Checks

| When | Branch | Verdict | Report |
|------|--------|---------|--------|

Append newest first.


Step 5 — Present to User

  1. Verdict in one line (READY / READY WITH WARNINGS / BLOCKED)
  2. Blockers and warnings (if any)
  3. Proposed commit message in a copy-paste block
  4. Path to saved report
  5. Ask: "Commit?" — only proceed on yes
  6. Ask: "Push?" — only if user wants push, and only after successful commit

If BLOCKED, list fixes needed. Do not commit.


Edge Cases

  • Clean working tree — report READY with note "nothing to commit"
  • Staged + unstaged mix — show both diffs; ask what to include
  • Monorepo — run checks from correct package directory or root per project convention
  • No package.json — rely on checklist + git review; skip Node checks
  • User says "commit anyway" on BLOCKED — warn once, then follow explicit override
  • Pre-commit hook fails — fix issue, re-run ship-check, new report (never amend unless user rules allow)

Invocation Examples

ship check
ready to commit?
pre-push check
commit and push   ← runs gate first; commit/push only after confirmation
quick ship check — skip tests
ship this branch

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.