diff --git a/CHANGELOG.md b/CHANGELOG.md index d1a7300..03b97fb 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,6 +5,12 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/). ## [Unreleased] +### Changed + +- The repository is public. The README no longer asks for private-repository + access or a contents-read token; another repository uses the Action directly + as `HlinorAI/sheetsentry@`. + ### Fixed - The composite GitHub Action installs SheetSentry from the action's own diff --git a/PROJECT_PLAN.md b/PROJECT_PLAN.md index 7449d10..f1a46f1 100644 --- a/PROJECT_PLAN.md +++ b/PROJECT_PLAN.md @@ -5,10 +5,11 @@ boundary: 17 audit rules, 8 diff rules, a finding-review workflow, and SARIF output for GitHub code scanning. One runtime dependency (`openpyxl`); everything else is the standard library. Python 3.10+. -## Current state (2026-10-01) +## Current state (2026-10-16) -- Private repository, version `0.1.0`, **not published** to PyPI. -- Full test suite: 96 tests, CI matrix 3 OS x 4 Python versions. +- Public repository (Apache-2.0) since 2026-10-16, version `0.1.0`, + **not published** to PyPI. +- Full test suite: 107 tests, CI matrix 3 OS x 4 Python versions. - Composite GitHub Action (`action.yml`) runs the CLI on the caller's workbooks and installs SheetSentry **from the action's own checked-out source** (`github.action_path`) — not from PyPI, where no package exists. @@ -22,7 +23,7 @@ everything else is the standard library. Python 3.10+. clean environment (asserts SheetSentry is not preinstalled), validates the SARIF report and the installed-source metadata (`direct_url.json`). - `README.md`: Install / In CI sections document source installation only and - the Python 3.10+ / private-repo prerequisites. + the Python 3.10+ prerequisite. - No version bump, no dependency changes, no release in this change. ## Multi-file output (SHEETSENTRY-002) diff --git a/README.md b/README.md index f52f456..c6b509b 100644 --- a/README.md +++ b/README.md @@ -36,7 +36,7 @@ Total: 3 findings (2 errors, 1 warning) ## Install SheetSentry is not on PyPI. Install from a checkout of this repository -(requires access to this private repo and Python 3.10+): +(requires Python 3.10+): ```bash git clone https://github.com/HlinorAI/sheetsentry.git @@ -100,8 +100,7 @@ Exit codes: `0` clean, `1` findings at or above `--fail-on` (default `error`), ` The repository ships a composite GitHub Action that installs SheetSentry from the action's own checked-out source — nothing is fetched from PyPI, because there is no SheetSentry package there. The consumer workflow needs Python -3.10+ set up first (the action installs with `pip`), and access to this -private repository. +3.10+ set up first (the action installs with `pip`). Same repository: @@ -117,21 +116,15 @@ Same repository: sarif_file: sheetsentry.sarif ``` -Another (private) repository: check out the consumer repo first, then the -action source, using a token that has **contents: read** on this repository -(create the token yourself; the examples below only reference it): +Another repository: reference the action directly. There are no release tags +yet, so pin a full commit SHA from this repository for reproducible runs: ```yaml -- uses: actions/checkout@v4 # the consumer repository -- uses: actions/checkout@v4 # the action's source - with: - repository: HlinorAI/sheetsentry - token: ${{ secrets.SHEETSSENTRY_SOURCE_READ }} - path: sheetsentry-action +- uses: actions/checkout@v4 - uses: actions/setup-python@v5 with: python-version: "3.11" -- uses: ./sheetsentry-action +- uses: HlinorAI/sheetsentry@ with: files: data/*.xlsx - uses: github/codeql-action/upload-sarif@v3 @@ -144,7 +137,7 @@ space-separated patterns, or one literal path — a path containing spaces works when it names exactly one existing file: ```yaml -- uses: ./sheetsentry-action +- uses: HlinorAI/sheetsentry@ with: files: reports/final report.xlsx ```