github-security-report 0.13.1__tar.gz → 0.14.1__tar.gz

github_security_report-0.14.1/LICENSES/Apache-2.0.txt

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

{github_security_report-0.13.1 → github_security_report-0.14.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: github-security-report
-Version: 0.13.1
+Version: 0.14.1
 Summary: Security and quality reporting across GitHub organisations
 Project-URL: Homepage, https://github.com/lfreleng-actions/github-security-report-action
 Project-URL: Repository, https://github.com/lfreleng-actions/github-security-report-action
@@ -29,15 +29,15 @@ Requires-Dist: jinja2==3.1.6
 Requires-Dist: jsonschema==4.26.0
 Requires-Dist: pyyaml==6.0.3
 Requires-Dist: rich==15.0.0
-Requires-Dist: typer==0.27.1
+Requires-Dist: typer==0.27.2
 Provides-Extra: dev
 Requires-Dist: mypy==2.3.1; extra == 'dev'
 Requires-Dist: pytest-asyncio==1.4.0; extra == 'dev'
 Requires-Dist: pytest-cov==7.1.0; extra == 'dev'
 Requires-Dist: pytest==9.1.1; extra == 'dev'
 Requires-Dist: respx==0.23.1; extra == 'dev'
-Requires-Dist: ruff==0.16.3; extra == 'dev'
-Requires-Dist: syrupy==5.5.3; extra == 'dev'
+Requires-Dist: ruff==0.16.5; extra == 'dev'
+Requires-Dist: syrupy==6.0.0; extra == 'dev'
 Requires-Dist: types-jsonschema==4.26.0.20260518; extra == 'dev'
 Requires-Dist: types-pyyaml==6.0.12.20250915; extra == 'dev'
 Description-Content-Type: text/markdown
@@ -179,7 +179,7 @@ organisation and **Repository access** set to *All repositories*, then grant:
 | Contents | `.github/dependabot.yml`, latest release, and tag dates |
 | Dependabot alerts | Open Dependabot vulnerability alerts |
 | Code scanning alerts | CodeQL / Scorecard / zizmor / aislop findings |
-| Secret scanning alerts | Open secret-scanning alerts |
+| Secret scanning alerts | Open secret-scanning alerts, across every GitHub pattern category |
 | Issues | Open issues and their labels (GitHub Issues table) |
 | Administration | Dependabot enablement + security-updates status, and effective branch rules |
 
@@ -187,7 +187,7 @@ organisation and **Repository access** set to *All repositories*, then grant:
 
 | Permission | Access | Used for |
 | ---------- | ------ | -------- |
-| Administration | Read and write | *Optional* — organisation rulesets (detect tools enforced through an org ruleset). GitHub gates this endpoint behind Administration **write**; omit it to keep the token read-only and skip ruleset-based tool coverage. |
+| Administration | Read (write for rulesets) | *Optional*, and the only permission here with a write variant. **Read** keeps the token read-only and unlocks GitHub's secret-scanning pattern inventory (see below). **Write** additionally unlocks organisation rulesets (detecting tools enforced through an org ruleset), which GitHub gates behind Administration write. Omit the permission entirely to skip both; everything else is unaffected. |
 
 > Read-only is enough for everything except the optional ruleset coverage
 > above. A fine-grained token cannot span organisations. For a report covering
@@ -203,7 +203,7 @@ organisations. Grant these scopes:
 | ----- | -------- |
 | `repo` | Repository data, including private repositories |
 | `security_events` | Code scanning, secret scanning, and Dependabot alerts (org-bulk and per-repo) |
-| `read:org` | Listing organisation repositories |
+| `read:org` | Listing organisation repositories, and GitHub's secret-scanning pattern inventory (see below) |
 | `admin:org` | *Optional* — reading organisation rulesets for ruleset-based tool coverage. GitHub gates `GET /orgs/{org}/rulesets` behind the full `admin:org` scope; `read:org` and `write:org` return 404. Omit it to skip that one signal; everything else is unaffected. |
 
 > For organisations that enforce SSO, the PAT must be **SSO-authorised** for
@@ -211,6 +211,33 @@ organisations. Grant these scopes:
 > unknown). Store the token as a secret (e.g. `LFRELENG_ACTIONS_REPORT_PAT`) and
 > reference it by env-var name via `token_env`; never embed it in the config.
 
+### Secret scanning covers three pattern categories
+
+GitHub's alerts API returns only its *default* provider patterns unless
+`secret_type` names something else, so two whole categories — the **generic**
+patterns (private keys, database connection strings, HTTP authentication
+headers) and the **AI-detected** ones (passwords) — are omitted from an
+ordinary sweep, and the endpoint answers `200 []` rather than an error. The
+report therefore sweeps twice, once unfiltered and once naming the patterns
+GitHub leaves out, and merges the results.
+
+If either half fails, the repository is reported as **unknown** rather than as
+the surviving half's answer — a partial sweep can never stand in for a clean
+bill of health. Alerts the successful half did find are still reported, and a
+repository with any of them is an **offender** rather than unknown: an
+incomplete read can conceal a secret, never invent one, so positive evidence is
+acted on whatever else failed.
+
+Where the token can read
+`GET /orgs/{org}/secret-scanning/pattern-configurations`, the generic pattern
+names are checked against GitHub's own inventory, so a pattern GitHub renames
+surfaces as a warning instead of as a silently clean report. A classic PAT gets
+this from the `read:org` scope it already needs; a fine-grained token needs the
+optional organisation `Administration` permission (read). Where the token
+cannot read it, the check is skipped without comment and the sweep proceeds
+unchanged. The AI-detected patterns are absent from that inventory and so go
+unverified.
+
 ## Usage
 
 ### Org mode (scheduled report)
@@ -275,6 +302,7 @@ environment-variable name, never embedded.
     "include_test": false,
     "repo_min_age_days": 28,
     "release_max_age_days": 60,
+    "graph_batch": 10,
     "order": { "style": "auto" }
   },
   "organizations": [
@@ -695,9 +723,10 @@ is never presented as a clean one.
 The `pull_requests` category counts each repository's **open pull requests**,
 split by who raised them and by what is holding them up. The per-repository data
 rides the same batched GraphQL prefetch as the issues data, so it costs **no
-extra requests per repository** — measured against a five-repository batch,
-adding the connection, the head commit's check rollup and the assignee list
-moved the query cost from 1 point to 4, against an hourly budget of 5,000.
+extra requests per repository** — measured against a 25-repository batch, the
+whole prefetch costs 20 points without the review-thread scan that feeds
+`Copilot` and 151 with it, against an hourly budget of 5,000. A 118-repository
+organisation therefore spends roughly 755 points per run.
 
 Identifying contributors does add **two requests per organisation**, made once
 per run and reused by every repository and both author-aware tables:
@@ -707,17 +736,17 @@ organisation](#inside-or-outside-the-organisation):
 
 ```text
 Pull Requests
-┏━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━┳━━━━━┳━━━━━━┳━━━━━━━━━━┳━━━━━━┳━━━━━━━┳━━━━━━━┓
-┃ Repository           ┃ Human ┃ Ext ┃ Auto ┃ Conflict ┃ Fail ┃ Draft ┃ Total ┃
-┡━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━╇━━━━━╇━━━━━━╇━━━━━━━━━━╇━━━━━━╇━━━━━━━╇━━━━━━━┩
-│ lftools-uv           │     8 │   0 │    0 │        0 │    0 │     0 │     8 │
-│ dependamerge         │     3 │   0 │    0 │        0 │    0 │     0 │     3 │
-│ gha-workflow-linter  │     2 │   0 │    0 │        0 │    1 │     1 │     2 │
-│ harden-runner-block- │     1 │   0 │    0 │        1 │    0 │     1 │     1 │
-│ action               │       │     │      │          │      │       │       │
-├─────────────────────┼───────┼─────┼──────┼──────────┼──────┼───────┼───────┤
-│ Total                │    14 │   0 │    0 │        1 │    1 │     2 │    14 │
-└─────────────────────┴───────┴─────┴──────┴──────────┴──────┴───────┴───────┘
+┏━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━┳━━━━━┳━━━━━━┳━━━━━━━━━━┳━━━━━━┳━━━━━━━━━┳━━━━━━━┳━━━━━━━┓
+┃ Repository           ┃ Human ┃ Ext ┃ Auto ┃ Conflict ┃ Fail ┃ Copilot ┃ Draft ┃ Total ┃
+┡━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━╇━━━━━╇━━━━━━╇━━━━━━━━━━╇━━━━━━╇━━━━━━━━━╇━━━━━━━╇━━━━━━━┩
+│ lftools-uv           │     8 │   0 │    0 │        0 │    0 │       0 │     0 │     8 │
+│ dependamerge         │     3 │   0 │    0 │        0 │    0 │       2 │     0 │     3 │
+│ gha-workflow-linter  │     2 │   0 │    0 │        0 │    1 │       0 │     1 │     2 │
+│ harden-runner-block- │     1 │   0 │    0 │        1 │    0 │       0 │     1 │     1 │
+│ action               │       │     │      │          │      │         │       │       │
+├─────────────────────┼───────┼─────┼──────┼──────────┼──────┼─────────┼───────┼───────┤
+│ Total                │    14 │   0 │    0 │        1 │    1 │       2 │     2 │    14 │
+└─────────────────────┴───────┴─────┴──────┴──────────┴──────┴─────────┴───────┴───────┘
   … and 9 more
   ❌ 13 With open pull requests
   ✅ 104 No open pull requests
@@ -731,21 +760,45 @@ The columns form **two independent groupings**:
 | `Ext` | Human pull requests raised from outside the organisation — a **subset of Human**, which is why it sits beside it. |
 | `Conflict` | Blocked on a merge conflict. |
 | `Fail` | Latest checks did not pass. The rollup includes optional checks, so this is not by itself proof that the merge is blocked. |
+| `Copilot` | Carries at least one **unresolved review thread** opened by GitHub's automated code reviewer. |
 | `Draft` | Marked as a draft. |
 
-`Conflict`, `Fail` and `Draft` **overlap** each other and the author split, so
-they do not sum to `Total` and are not meant to: one pull request that is
-conflicting, failing *and* a draft is counted once in each of those three
+`Conflict`, `Fail`, `Copilot` and `Draft` **overlap** each other and the author
+split, so they do not sum to `Total` and are not meant to: one pull request that
+is conflicting, failing *and* a draft is counted once in each of those three
 columns, and once under `Human` or `Auto`. Only `Human` + `Auto` reconciles with
 the collected total. They are ordered worst-first — a conflict needs a human to
-rebase, a failing check may only need a re-run, and a draft is not blocked at
+rebase, a failing check may only need a re-run, unresolved review feedback needs
+a human but does not hold the merge button down, and a draft is not blocked at
 all.
 
+#### Unresolved Copilot feedback
+
+`Copilot` counts the pull requests **waiting on a human to answer a review**. A
+review thread counts when it was opened by GitHub's automated code reviewer (the
+`copilot-pull-request-reviewer` bot) and nobody has resolved it. The reviewer is
+identified from each thread's **opening** comment, since later replies are
+usually the human answering the review.
+
+An **outdated** thread still counts: GitHub marks a thread outdated when the
+code beneath it changes, but that does not resolve it, so the feedback remains
+unanswered.
+
+Any non-zero count is coloured **red**, like `Conflict` and `Fail` — it marks a
+pull request that cannot progress until somebody responds. The count also feeds
+the row ranking, so a backlog awaiting review outranks an untouched one of the
+same size.
+
+The scan reads up to **20 review threads per pull request**, which is the single
+most expensive part of the prefetch (see the cost figures above). Where a pull
+request carries more threads than that and none of the collected ones qualifies,
+the pull request is treated as **indeterminate** rather than clear — see below.
+
 #### Automation backlog thresholds
 
 On the terminal the counts are coloured so the table reads at a glance: `Human`
-and `Ext` **green**, `Conflict` and `Fail` **red**, and `Auto` coloured against
-two configured thresholds.
+and `Ext` **green**, `Conflict`, `Fail` and `Copilot` **red**, and `Auto`
+coloured against two configured thresholds.
 
 Dependabot stops raising pull requests once a repository reaches its
 `open-pull-requests-limit`, so the repository quietly stops receiving dependency
@@ -967,15 +1020,24 @@ reports as an App and any unrecognised login carrying the `[bot]` marker — so
 future bot is classified as automation rather than mistaken for an outside
 contributor.
 
-`Fail` and `Conflict` count only **established** states. GitHub computes
-mergeability lazily and answers `UNKNOWN` until it settles, and reports no check
-rollup at all when no checks have run; neither absence is evidence that a pull
-request is ready, so neither is counted either way.
+`Fail`, `Conflict` and `Copilot` count only **established** states. GitHub
+computes mergeability lazily and answers `UNKNOWN` until it settles, and reports
+no check rollup at all when no checks have run; neither absence is evidence that
+a pull request is ready, so neither is counted either way. `Copilot` follows the
+same rule: a pull request carrying more review threads than the 20-thread window
+returned, with nothing unresolved among the ones collected, is left uncounted
+rather than reported as clear — an unresolved thread may sit among those never
+seen. Review threads that could not be read at all, or whose count came back
+unusable so the window's coverage cannot be established, are treated the same
+way. Because an uncounted pull request renders as an ordinary `0`, a table
+holding any such reading says so in its description: `Copilot` then
+**undercounts and should be read as a lower bound**, exactly as `Ext` does when
+membership cannot be read.
 
 Repositories with no open pull requests are counted in the footer rather than
-listed. Rows rank by total open pull requests, then by those failing or
-conflicting (`Fail` + `Conflict`), so two repositories with equal backlogs
-surface the more
+listed. Rows rank by total open pull requests, then by those failing,
+conflicting or awaiting Copilot feedback (counted once each, since the columns
+overlap), so two repositories with equal backlogs surface the more
 stuck one first.
 
 > **Accuracy note.** As with the issues table, `Total` is exact at any size,
@@ -1066,6 +1128,55 @@ Gating decides **collection**; the per-category render toggles above decide
 **presentation**. A skipped section still renders (as the one-line notice)
 unless its category is also disabled.
 
+### GraphQL prefetch batch size
+
+The releases/tags, Dependabot-enablement, open-issues and pull-request data
+for every in-scope repository comes from one aliased GraphQL query per batch
+of repositories rather than a round-trip per repository. GitHub bounds how
+much work a single GraphQL query may do — roughly ten seconds of execution —
+and reports a breach in one of three shapes, each after the query has already
+run for the full limit: an **HTTP 502** (or 504) gateway timeout from the
+edge, an HTTP 200 carrying no `data`, or an HTTP 200 whose `errors` say
+`Resource limits for this query exceeded` with the unresolved fields nulled.
+Each aliased repository adds a few hundred milliseconds, so the batch
+size is bounded by *latency*, not by rate-limit cost: 25 repositories measured
+at ~9 s against `lfreleng-actions` and failed intermittently; 10 measured at
+~3.5 s.
+
+`report.graph_batch` (default `10`; minimum `1`) sets the starting batch size,
+globally or per organisation. It is a lever for a slow day rather than a hard
+limit: a batch that still fails on size after the transport's own retries is
+re-issued at **half** the size, and the smaller size is kept for the rest of
+that organisation's collection (each organisation in a multi-org run starts
+from its own configured size, since organisations differ in how much data a
+repository carries). Only a single-repository query GitHub still cannot
+answer, or a failure that a smaller query could not fix (a `403`, an
+exhausted rate limit, or a `500`/`503` outage rather than a `502`/`504`
+timeout), aborts the run with exit code `3`.
+
+The value can be set three ways, in this order of precedence:
+
+1. `--graph-batch N` on the command line (the action's `graph_batch` input).
+2. A **repository or organisation variable** passed to that input. The
+   bundled `reporting.yaml` passes `vars.GSR_GRAPH_BATCH`, so the size can be
+   adjusted from repository settings without a workflow edit or a release;
+   a caller's own workflow can do the same. (The `vars` context is not
+   available inside a composite action, so the action cannot read it itself.)
+3. `report.graph_batch` in the configuration; otherwise the built-in `10`.
+
+Batching changes how many requests carry the data, not how many GraphQL nodes
+are resolved, so the node work is the same whatever the batch size. A smaller
+batch does cost slightly more of the rate-limit budget — each query is charged
+at least one point, and per-query cost rounding adds a little when one query
+becomes several — and a few more requests (a 124-repository organisation is 13
+queries at 10, 5 at 25). Against the 5,000-point hourly budget that is noise;
+a larger value buys nothing except a longer first failure.
+
+> The flag and input are recent additions. An empty input is not passed to
+> the tool, so an unset variable cannot break a run; but a pinned tool version
+> predating the flag will reject a set one with `No such option`, so set
+> `GSR_GRAPH_BATCH` only once the pinned release supports it.
+
 ### Pass/fail severity cutoff
 
 The severity-ranked signals (CodeQL, Scorecard, Zizmor, aislop, Dependabot
@@ -1143,6 +1254,7 @@ and the Slack **bot token** is consumed by the workflow, not the CLI.
 | `fail_threshold` | No | `none` | `none`/`low`/`medium`/`high`/`critical`/`any` (repo mode) |
 | `force_notify` | No | `false` | Post to Slack regardless of `report_day` |
 | `hide` | No | `""` | Category keys to suppress on every output (space- or comma-separated). Overrides config, and is one-way: it cannot re-enable a disabled category |
+| `graph_batch` | No | `""` | Repositories per batched GraphQL prefetch query (minimum `1`; default: config, else `10`). Pass a repository or organisation variable such as `${{ vars.GSR_GRAPH_BATCH }}` to adjust it from settings. A batch that still fails is halved automatically, so this sets the starting size (see [GraphQL prefetch batch size](#graphql-prefetch-batch-size)) |
 | `tool_version` | No | `""` | Published PyPI version to install. Empty (the default) uses the Dependabot-managed pin in `.github/runtime-pin/requirements.txt`; set a specific version to override. Ignored on pull requests or when `use_local_source` is `true` (both run from source) |
 | `use_local_source` | No | `false` | Run from the checked-out source instead of PyPI (for testing unreleased code from any event) |
 
@@ -1186,7 +1298,7 @@ API in the same way.
 | `0` | The report ran. |
 | `1` | Repo mode only: findings met or exceeded `--fail-threshold`. |
 | `2` | Usage or configuration error (bad flag, unreadable config). |
-| `3` | The GitHub API was unreachable after the retry budget. |
+| `3` | The GitHub API was unusable after the retry budget (see below). |
 | `4` | GitHub rejected the credentials (HTTP 401). |
 
 Codes `3` and `4` are **aborts, not reports**: nothing is written and no Pages
@@ -1197,8 +1309,19 @@ section `No data` or `All Clean` — and a scheduled job would then publish it
 over the last good one. Reporting false data is worse than reporting none, so
 the run stops at the first rejected request.
 
+Code `3` covers a GitHub API that could not be reached at all, and a GraphQL
+prefetch that failed as a whole: either a size-shaped failure (`502`/`504`
+timeout, `200` with no data, resource limits exceeded) that persisted even
+after the batch had been halved down to one repository, or a failure that
+halving could not have fixed (`403`, an exhausted GraphQL rate limit, a
+`500`/`503` outage), which aborts at once. The message reports the status or
+cause and ends with the matching next step — a smaller `--graph-batch`, retry
+later, wait for the rate-limit budget to reset, or check the token's
+permissions — so read it rather than assuming "retry later" (see
+[GraphQL prefetch batch size](#graphql-prefetch-batch-size)).
+
 The two are separate codes because the remedy differs: `4` means rotate or fix
-the token, `3` means retry later.
+the token, `3` usually means retry later.
 
 ## Remediation