shipcheck-cli 0.1.0__tar.gz → 0.2.0__tar.gz

{shipcheck_cli-0.1.0 → shipcheck_cli-0.2.0}/.github/workflows/ci.yml

@@ -37,8 +37,14 @@ jobs:
       - name: Build package
         run: python -m build
 
-      - name: Validate wheel metadata
+      - name: Install built wheel
         run: python -m pip install dist/*.whl --force-reinstall
 
-      - name: CLI smoke test
-        run: shipcheck . --json
+      - name: CLI JSON smoke test
+        run: shipcheck . --format json > shipcheck.json
+
+      - name: CLI SARIF smoke test
+        run: shipcheck . --format sarif > shipcheck.sarif
+
+      - name: Validate SARIF document
+        run: python -c "import json; d=json.load(open('shipcheck.sarif')); assert d['version']=='2.1.0'; assert d['runs'][0]['tool']['driver']['name']=='ShipCheck'"

{shipcheck_cli-0.1.0 → shipcheck_cli-0.2.0}/CHANGELOG.md

@@ -4,6 +4,18 @@ All notable changes to ShipCheck are documented here.
 
 The format follows [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and versions follow Semantic Versioning.
 
+## [0.2.0] - 2026-09-09
+
+### Added
+
+- Native composite GitHub Action interface.
+- SARIF 2.1.0 output for GitHub Code Scanning.
+- Actionable diagnostics for failed and warning checks.
+- Stable documented exit codes.
+- `.shipcheck.toml` ignore configuration for checks and paths.
+- Safe `--fix` automation for conservative project templates.
+- Provider detection and validation for Render, Railway, Fly.io, Netlify, and AWS.
+
 ## [0.1.0] - 2026-09-09
 
 ### Added
@@ -19,4 +31,5 @@ The format follows [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and
 - Automated test coverage and GitHub Actions CI across Python 3.11–3.13.
 - Python package build and CLI smoke-test validation in CI.
 
+[0.2.0]: https://github.com/farukislamyt/ShipCheck/releases/tag/v0.2.0
 [0.1.0]: https://github.com/farukislamyt/ShipCheck/releases/tag/v0.1.0

shipcheck_cli-0.2.0/PKG-INFO

@@ -0,0 +1,162 @@
+Metadata-Version: 2.5
+Name: shipcheck-cli
+Version: 0.2.0
+Summary: Pre-deployment health checks for software projects.
+Author: Faruk Islam
+License: MIT
+License-File: LICENSE
+Requires-Python: >=3.11
+Requires-Dist: pyyaml>=6.0
+Requires-Dist: rich>=13.7
+Requires-Dist: typer>=0.12
+Provides-Extra: dev
+Requires-Dist: pytest>=8.0; extra == 'dev'
+Requires-Dist: ruff>=0.6; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# ShipCheck
+
+> Know if your project is ready to deploy.
+
+ShipCheck is a developer-first CLI that scans a project before deployment and highlights configuration problems, missing files, exposed secrets, dependency issues, and deployment risks.
+
+## Status
+
+🚀 **v0.2.0** — CI/CD integration, SARIF, diagnostics, provider expansion, and safe fixes.
+
+## What it checks
+
+- Git repository and working-tree status
+- Framework detection
+- `.gitignore` and environment configuration
+- Secret detection
+- Dependency manifests
+- Deployment configuration
+- Provider-specific configuration for Vercel, Docker, GitHub Actions, Render, Railway, Fly.io, Netlify, AWS, and Procfile-compatible targets
+- Tests and CI/CD signals
+- Project documentation
+
+## Installation
+
+### From PyPI
+
+```bash
+python -m pip install shipcheck-cli
+```
+
+### From source
+
+```bash
+git clone https://github.com/farukislamyt/ShipCheck.git
+cd ShipCheck
+python -m pip install -e ".[dev]"
+```
+
+## CLI usage
+
+```bash
+shipcheck .
+shipcheck . --gate
+shipcheck . --gate --threshold 90
+```
+
+Machine-readable output:
+
+```bash
+shipcheck . --format json
+shipcheck . --format sarif > shipcheck-results.sarif
+```
+
+`--json` remains supported as a compatibility alias for JSON output.
+
+### Diagnostics
+
+Non-passing checks include actionable recommendations in terminal and JSON output. Secret findings identify only the file and credential type; secret values are never printed.
+
+### Safe fixes
+
+Use `--fix` for narrowly scoped local fixes that do not overwrite application code:
+
+```bash
+shipcheck . --fix
+```
+
+Currently this can create a conservative `.gitignore` and copy `.env.template` to `.env.example` when the latter is missing. Always review generated files before committing them.
+
+## Configuration
+
+Create `.shipcheck.toml`:
+
+```toml
+[shipcheck]
+threshold = 80
+
+[shipcheck.ignore]
+checks = ["Tests"]
+paths = ["examples/", "fixtures/"]
+```
+
+The CLI `--threshold` option takes precedence over the configuration file. Invalid configuration returns exit code `2`.
+
+## Exit codes
+
+| Code | Meaning |
+|---:|---|
+| 0 | Scan completed and the deployment gate passed or was not requested |
+| 1 | `--gate` blocked deployment |
+| 2 | Invalid `.shipcheck.toml` configuration |
+| 3 | Reserved for usage-level failures |
+
+## GitHub Action
+
+ShipCheck can run as a native composite action:
+
+```yaml
+name: ShipCheck
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+
+permissions:
+  contents: read
+  security-events: write
+
+jobs:
+  shipcheck:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: farukislamyt/ShipCheck@v0.2.0
+        with:
+          threshold: "80"
+          gate: "true"
+          format: sarif
+```
+
+The action installs the released `shipcheck-cli` package and uploads SARIF results to GitHub Code Scanning.
+
+## Release process
+
+Releases are tag-driven. The GitHub Actions release workflow validates the tag against `pyproject.toml`, builds the package, validates distributions, creates the GitHub Release, and publishes to PyPI using trusted publishing.
+
+```bash
+git tag v0.2.0
+git push origin v0.2.0
+```
+
+See [CHANGELOG.md](CHANGELOG.md) for release history.
+
+## Development
+
+```bash
+python -m pip install -e ".[dev]"
+ruff check .
+pytest -q
+python -m build
+```
+
+## License
+
+MIT License.

shipcheck_cli-0.2.0/README.md

@@ -0,0 +1,146 @@
+# ShipCheck
+
+> Know if your project is ready to deploy.
+
+ShipCheck is a developer-first CLI that scans a project before deployment and highlights configuration problems, missing files, exposed secrets, dependency issues, and deployment risks.
+
+## Status
+
+🚀 **v0.2.0** — CI/CD integration, SARIF, diagnostics, provider expansion, and safe fixes.
+
+## What it checks
+
+- Git repository and working-tree status
+- Framework detection
+- `.gitignore` and environment configuration
+- Secret detection
+- Dependency manifests
+- Deployment configuration
+- Provider-specific configuration for Vercel, Docker, GitHub Actions, Render, Railway, Fly.io, Netlify, AWS, and Procfile-compatible targets
+- Tests and CI/CD signals
+- Project documentation
+
+## Installation
+
+### From PyPI
+
+```bash
+python -m pip install shipcheck-cli
+```
+
+### From source
+
+```bash
+git clone https://github.com/farukislamyt/ShipCheck.git
+cd ShipCheck
+python -m pip install -e ".[dev]"
+```
+
+## CLI usage
+
+```bash
+shipcheck .
+shipcheck . --gate
+shipcheck . --gate --threshold 90
+```
+
+Machine-readable output:
+
+```bash
+shipcheck . --format json
+shipcheck . --format sarif > shipcheck-results.sarif
+```
+
+`--json` remains supported as a compatibility alias for JSON output.
+
+### Diagnostics
+
+Non-passing checks include actionable recommendations in terminal and JSON output. Secret findings identify only the file and credential type; secret values are never printed.
+
+### Safe fixes
+
+Use `--fix` for narrowly scoped local fixes that do not overwrite application code:
+
+```bash
+shipcheck . --fix
+```
+
+Currently this can create a conservative `.gitignore` and copy `.env.template` to `.env.example` when the latter is missing. Always review generated files before committing them.
+
+## Configuration
+
+Create `.shipcheck.toml`:
+
+```toml
+[shipcheck]
+threshold = 80
+
+[shipcheck.ignore]
+checks = ["Tests"]
+paths = ["examples/", "fixtures/"]
+```
+
+The CLI `--threshold` option takes precedence over the configuration file. Invalid configuration returns exit code `2`.
+
+## Exit codes
+
+| Code | Meaning |
+|---:|---|
+| 0 | Scan completed and the deployment gate passed or was not requested |
+| 1 | `--gate` blocked deployment |
+| 2 | Invalid `.shipcheck.toml` configuration |
+| 3 | Reserved for usage-level failures |
+
+## GitHub Action
+
+ShipCheck can run as a native composite action:
+
+```yaml
+name: ShipCheck
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+
+permissions:
+  contents: read
+  security-events: write
+
+jobs:
+  shipcheck:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: farukislamyt/ShipCheck@v0.2.0
+        with:
+          threshold: "80"
+          gate: "true"
+          format: sarif
+```
+
+The action installs the released `shipcheck-cli` package and uploads SARIF results to GitHub Code Scanning.
+
+## Release process
+
+Releases are tag-driven. The GitHub Actions release workflow validates the tag against `pyproject.toml`, builds the package, validates distributions, creates the GitHub Release, and publishes to PyPI using trusted publishing.
+
+```bash
+git tag v0.2.0
+git push origin v0.2.0
+```
+
+See [CHANGELOG.md](CHANGELOG.md) for release history.
+
+## Development
+
+```bash
+python -m pip install -e ".[dev]"
+ruff check .
+pytest -q
+python -m build
+```
+
+## License
+
+MIT License.

shipcheck_cli-0.2.0/action.yml

@@ -0,0 +1,39 @@
+name: ShipCheck
+description: Check whether a project is ready to deploy
+branding:
+  icon: check-circle
+  color: green
+inputs:
+  threshold:
+    description: Minimum readiness score required by the deployment gate
+    required: false
+    default: "80"
+  gate:
+    description: Fail the action when readiness is below threshold or a check fails
+    required: false
+    default: "true"
+  format:
+    description: Output format (text, json, sarif)
+    required: false
+    default: sarif
+runs:
+  using: composite
+  steps:
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: "3.11"
+    - name: Install ShipCheck
+      shell: bash
+      run: python -m pip install --disable-pip-version-check shipcheck-cli==0.2.0
+    - name: Run ShipCheck
+      shell: bash
+      run: |
+        args=(. --format "${{ inputs.format }}" --threshold "${{ inputs.threshold }}")
+        if [ "${{ inputs.gate }}" = "true" ]; then args+=(--gate); fi
+        shipcheck "${args[@]}" > shipcheck-results.json
+    - name: Upload SARIF results
+      if: ${{ inputs.format == 'sarif' && always() }}
+      uses: github/codeql-action/upload-sarif@v3
+      with:
+        sarif_file: shipcheck-results.json

{shipcheck_cli-0.1.0 → shipcheck_cli-0.2.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "shipcheck-cli"
-version = "0.1.0"
+version = "0.2.0"
 description = "Pre-deployment health checks for software projects."
 readme = "README.md"
 requires-python = ">=3.11"
@@ -30,7 +30,6 @@ packages = ["src/shipcheck"]
 
 [tool.ruff]
 line-length = 120
-
 target-version = "py311"
 
 [tool.pytest.ini_options]