Skip to content

Commit 5fc3b67

Browse files
committed
Correct the supported-patterns failure and the empty-baseline trigger
A failed GET report/supported raises from the SDK and stops the run; the bundled pattern list only covers a non-error response with no body. An empty baseline is created when the repository has no head scan, not on every new branch, since a branch compares against the repository's head scan.
1 parent 06869b4 commit 5fc3b67

1 file changed

Lines changed: 7 additions & 5 deletions

File tree

‎docs/troubleshooting.md‎

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ Every run:
5252
| API call | Scope | Purpose |
5353
|:---|:---|:---|
5454
| `GET organizations` | none | Resolve the org ID and slug from the token |
55-
| `GET report/supported` | none | Fetch supported manifest patterns. On failure the CLI uses a bundled list that covers fewer ecosystems |
55+
| `GET report/supported` | none | Fetch supported manifest patterns. A failed request, such as a timeout or an invalid token, stops the run |
5656
| `POST orgs/{org}/full-scans` | `full-scans:create` | Create the new scan. With an organization-wide token, the server creates the repository if it does not exist yet |
5757

5858
Diff-producing runs (see [which runs compare](#apiaccessdenied-on-the-scan-comparison)) add:
@@ -147,8 +147,9 @@ Grant `repo:create`, or create the repository in Socket before the first pipelin
147147

148148
## Baseline scans that do not appear in the dashboard
149149

150-
On the first scan of a repository or branch there is no head scan to diff against, so
151-
the CLI creates a **temporary empty baseline** and compares to that:
150+
A diff-producing run compares against the repository's head scan. When the repository
151+
has none yet, usually on its first comparison, the CLI creates a **temporary empty
152+
baseline** and compares to that:
152153

153154
```
154155
No previous scan found - creating empty baseline scan
@@ -161,8 +162,9 @@ repository head or default branch, so it does not show up as a repository scan i
161162
dashboard. Looking it up by ID will come up empty. This is expected — the scan to look
162163
at is the "New scan ID".
163164

164-
Because everything is new relative to an empty baseline, the first run also reports
165-
every package as added and zero as unchanged.
165+
Because everything is new relative to an empty baseline, that comparison reports
166+
every package as added and zero as unchanged. A new branch of a repository that
167+
already has a head scan compares against that head scan, not an empty baseline.
166168

167169
## Reachability scan IDs are not full-scan IDs
168170

0 commit comments

Comments
 (0)