Skip to content

Commit 39323c4

Browse files
committed
Describe which runs compare without pinning it to a release
1 parent db69ae4 commit 39323c4

2 files changed

Lines changed: 7 additions & 5 deletions

File tree

‎docs/ci-cd.md‎

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -623,9 +623,11 @@ Prebuilt examples in this repo:
623623
the console table, including native Buildkite job logs, and in GitHub/GitLab
624624
security comments when that SCM adapter is configured. Findings without a known
625625
patched release leave the console cell blank and omit the comment field.
626-
- A token missing the `diff-scans:*` permissions does not fail the build — it logs
626+
- A token missing the `diff-scans:*` scopes does not fail the build. It logs
627627
`Diff scan comparison failed with APIAccessDenied(Insufficient permissions)` and falls
628-
back to a less resilient comparison path. This affects PR/MR events and the
629-
`--scm api` / `--enable-diff` paths; since 2.9.0 an SCM-integrated branch push
630-
creates a full scan instead and never reaches it. See
628+
back to a less resilient comparison path. This affects every run that compares
629+
scans: PR/MR events, and runs without an SCM integration. An SCM-integrated branch
630+
push creates a full scan and never compares. The
631+
[CI/CD token setup guide](https://docs.socket.dev/docs/create-socket-api-key-for-cicd)
632+
leaves both scopes out; see
631633
[`troubleshooting.md#api-token-permissions`](troubleshooting.md#api-token-permissions).

‎docs/troubleshooting.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ Diff scan comparison failed with APIAccessDenied(Insufficient permissions), fall
8989

9090
The scan still succeeds and the diff results are the same, so this is easy to miss.
9191

92-
**Which runs produce a diff.** As of 2.9.0:
92+
**Which runs produce a diff:**
9393

9494
| Run | Compares? |
9595
|:---|:---|

0 commit comments

Comments
 (0)