shipready 1.0.2 → 1.1.0

package/README.md

@@ -159,7 +159,9 @@ Optional `shipready.config.json` in your project root:
 
 ## Using in CI
 
-`shipready check` exits with code `1` when errors are found:
+### GitHub Action (recommended)
+
+Add the quality gate to any workflow with a single step:
 
 ```yaml
 # .github/workflows/quality.yml
@@ -170,9 +172,33 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
-      - uses: actions/setup-node@v4
+      - uses: formalness/shipready@v1
+```
+
+The job fails when errors (secrets, unignored `.env`, ...) are found.
+
+| Input | Default | Purpose |
+| --- | --- | --- |
+| `path` | `.` | Project directory to scan |
+| `verbose` | `true` | Show file/line locations for every finding |
+| `version` | `latest` | shipready version to run (npm tag or exact version) |
+| `args` | `""` | Extra arguments for `shipready check` (e.g. `--json`) |
+
+Example with options:
+
+```yaml
+      - uses: formalness/shipready@v1
         with:
-          node-version: 20
+          path: apps/web
+          verbose: "false"
+          version: "1.0.3"
+```
+
+### Manual setup
+
+`shipready check` exits with code `1` when errors are found, so it works in any CI:
+
+```yaml
       - run: npx shipready check --verbose
 ```
 

package/dist/cli.js

@@ -1,5 +1,6 @@
 import fs from "node:fs";
 import path from "node:path";
+import { fileURLToPath } from "node:url";
 import { Command } from "commander";
 import pc from "picocolors";
 import { detectProject, runScan, scanFiles } from "./scanner.js";
@@ -46,7 +47,7 @@ async function applyFixes(root, force) {
 /** Reads the CLI's own version from its package.json (works from dist/ at runtime). */
 function ownVersion() {
     try {
-        const pkgPath = path.resolve(path.dirname(new URL(import.meta.url).pathname), "..", "package.json");
+        const pkgPath = path.resolve(path.dirname(fileURLToPath(import.meta.url)), "..", "package.json");
         const pkg = JSON.parse(fs.readFileSync(pkgPath, "utf8"));
         return pkg.version ?? "0.0.0";
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "shipready",
-  "version": "1.0.2",
+  "version": "1.1.0",
   "description": "Pre-flight check for your repo before shipping. Scans AI-coded projects for secrets, env issues, debug leftovers, and generates AI-agent instruction files.",
   "type": "module",
   "license": "MIT",