Add documentation for api key setup in github actions #1185
Conversation
There was a problem hiding this comment.
@blakehatch This is good, but it's missing a section. If customers use a secret manager, they should have some example code of how to call and read a secret stored elsewhere. Take a look at this Hashicorp example. We only need to document one to give an idea. Otherwise, looks good.
Reviewable status: 0 of 1 LGTMs obtained, and pending CI: Remote / large-ubuntu-22.04, integration-tests (20.04), integration-tests (22.04), pre-commit-checks, and 1 discussions need to be resolved
docs/src/content/docs/nativelink-cloud/api-key.mdx line 27 at r1 (raw file):
merge-to-main actions, use a Read/Write key stored in the secrets context. :::
I feel like it can go here:
### Third-Party Secrets Management
There was a problem hiding this comment.
Reviewable status: 1 of 1 LGTMs obtained, and pending CI: Bazel Dev / ubuntu-22.04, Cargo Dev / macos-13, Cargo Dev / ubuntu-22.04, Installation / macos-13, Installation / macos-14, Local / ubuntu-22.04, Publish nativelink-worker-init, Remote / large-ubuntu-22.04, asan / ubuntu-22.04, docker-compose-compiles-nativelink (20.04), docker-compose-compiles-nativelink (22.04), integration-tests (20.04), integration-tests (22.04), macos-13, ubuntu-20.04 / stable, ubuntu-22.04, ubuntu-22.04 / stable, windows-2022 / stable, and 1 discussions need to be resolved
MarcusSorealheis
force-pushed
the
api-key-docs
branch
from
cf2a1df to
cd9dc60
Compare
There was a problem hiding this comment.
Reviewable status: 1 of 1 LGTMs obtained, and 1 discussions need to be resolved
docs/src/content/docs/nativelink-cloud/api-key.mdx line 27 at r1 (raw file):
Previously, MarcusSorealheis (Marcus Eagan) wrote…
I feel like it can go here:
### Third-Party Secrets Management
Done.
There was a problem hiding this comment.
Dismissed @MarcusSorealheis from a discussion.
Reviewable status:complete! 1 of 1 LGTMs obtained
Description
Adds a section to the docs for production grade setups for API key secrets in different CI systems, specifically github actions to start.
:::note
Will pass vale pre-commit warning level before landing
:::
This change is