Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Jym77 committed Nov 20, 2024
1 parent e391493 commit 0269161
Showing 1 changed file with 16 additions and 2 deletions.
18 changes: 16 additions & 2 deletions packages/alfa-test-utils/docs/usage/reporting/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,22 @@ const pageReportURL = Audit.run(alfaPage, {
});
```

## Including the site ID

If you are testing a page that belongs to a specific site in the Siteimprove Intelligence Platform, you can provide the site ID. This will help produce better metadata and aggregates.

```typescript
const pageReportURL = Audit.run(alfaPage, {
rules: { include: Rules.aaFilter },
}).then((alfaResult) => {
SIP.upload(alfaResult, {
userName: process.env.SI_USER_NAME!,
apiKey: process.env.SI_API_KEY!,
siteId: "123456",
});
});
```

## Skipping git information

If you prefer not to upload basic git information about the repository (origin URL; branch name; latest commit hash, author, and message), use the `includeGitInfo: false` option:
Expand All @@ -47,5 +63,3 @@ SIP.upload(alfaResult, {
includeGitInfo: false,
});
```


0 comments on commit 0269161

Please sign in to comment.