|
4 | 4 |
|
5 | 5 | ### Documentation |
6 | 6 |
|
7 | | -- Documented the API token scopes `socketcli` needs, and which API call each one |
8 | | - covers, in |
9 | | - [Troubleshooting](docs/troubleshooting.md#api-token-permissions). Each mapping |
10 | | - comes from the scope the API checks for that endpoint. |
11 | | -- The [CI/CD token setup guide](https://docs.socket.dev/docs/create-socket-api-key-for-cicd) |
12 | | - does not list `diff-scans:create` or `diff-scans:list`. A token set up from it |
13 | | - falls back to the older scan comparison on every run that compares scans, with only a |
14 | | - warning in the log. The troubleshooting page now says to add both, and notes that |
15 | | - the CLI never uses four of the guide's scopes: `repo:update`, |
16 | | - `security-policy:read`, `triage:alerts-list` and `triage:alerts-update`. |
17 | | -- Corrected the `APIAccessDenied` comparison guidance. It applies to every run that |
18 | | - compares scans, not only pull requests, and the missing scopes are the |
19 | | - `diff-scans:*` pair, not `full-scans:list`. |
20 | | -- Documented three results that look like failures but aren't: the temporary empty |
21 | | - baseline on a repository's first scan, reachability scan IDs that aren't full-scan |
22 | | - IDs, and exit `2` when the token can't create the repository. Exit `2` is not |
23 | | - remapped by `--disable-blocking` or `--exit-code-on-api-error`. |
24 | | -- Listed all four accepted token environment variables in priority order, and fixed |
25 | | - the GitLab section, which named `$SOCKET_API_TOKEN` instead of |
26 | | - `SOCKET_SECURITY_API_TOKEN`. |
| 7 | +- New [API token permissions](docs/troubleshooting.md#api-token-permissions) guide: |
| 8 | + the scopes `socketcli` needs and the API calls each one covers. |
| 9 | +- Add `diff-scans:create` and `diff-scans:list` to CI tokens. Without them, scan |
| 10 | + comparisons fall back to a less resilient path with only a warning. |
| 11 | +- Documented why exit code `2` can mean the token can't create the repository. |
| 12 | +- Listed all four accepted token environment variables in priority order. |
27 | 13 |
|
28 | 14 | ## 2.12.0 |
29 | 15 |
|
|
0 commit comments