Skip to content

Commit d37bd90

Browse files
authored
Add read only key instructions to api key docs (TraceMachina#1187)
1 parent f59f8ba commit d37bd90

File tree

1 file changed

+12
-3
lines changed

1 file changed

+12
-3
lines changed

docs/src/content/docs/nativelink-cloud/api-key.mdx

+12-3
Original file line numberDiff line numberDiff line change
@@ -12,19 +12,28 @@ for use with GitHub Actions.
1212
[GitHub Repository Secrets Tutorial](https://docs.github.com/en/actions/security-guides/using-secrets-in-github-actions#creating-secrets-for-a-repository)
1313

1414
They can be access via the secrets context i.e.
15-
```
15+
```bash
1616
${{ secrets.YourSecretKeyName }}
1717
```
1818

19+
### Read Only keys
1920
:::note
2021
If your repository uses forks for pull requests (PRs), note that the secrets
2122
context isn't accessible from PRs originating from forks. To address this,
22-
we will soon introduce Read-Only keys.
23+
we introduced Read-Only keys.
24+
:::
2325

2426
Read-Only keys can be used for PRs and stored in the vars context. For
2527
merge-to-main actions, use a Read/Write key stored in the secrets context.
26-
:::
2728

29+
For Read Only API Keys you need to set these two flags:
30+
31+
```bash
32+
--nogenerate_json_trace_profile
33+
--remote_upload_local_results=false
34+
```
35+
36+
## Third-Party Secrets Management
2837
If you need info on setting up API keys for different CI environments, ask in
2938
the [Slack channel](https://nativelink.slack.com/join/shared_invite/zt-281qk1ho0-krT7HfTUIYfQMdwflRuq7A#/shared-invite/email)
3039
or open an issue on our [GitHub](https://github.com/TraceMachina/nativelink).

0 commit comments

Comments
 (0)