Skip to content

Commit

Permalink
chore(doc): add link to README.md#contacts
Browse files Browse the repository at this point in the history
  • Loading branch information
zhijie-yang committed Nov 14, 2024
1 parent 4d6a74c commit c9388e7
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions tools/cli-client/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,9 @@ A CLI client that triggers GitHub workflows for building, uploading and releasin
See ["How to Contribute as a Maintainer"](https://github.com/canonical/oci-factory?tab=readme-ov-file#as-a-maintainer--).

Upon finishing the onboarding, the user should add their GitHub username to the `contacts.yaml` file in the
`maintainers` field of the corresponding rock. This field is a list of GitHub usernames that are allowed to
trigger the build, upload, and release workflows. The onboarded user needs to generate a GitHub Personal Access Token
to authenticate themselves when using the CLI client.
[`maintainers` field](../../README.md#contacts) field of the corresponding rock. This field is a list of GitHub
usernames that are allowed to trigger the build, upload, and release workflows. The onboarded user needs to
generate a GitHub Personal Access Token to authenticate themselves when using the CLI client.

For a non-interactive terminal of the CLI client, it is possible to assign the token to the environmental variable
`export GITHUB_TOKEN=<your token>`, and pass `-y` to confirm the triggering by default.
Expand Down

0 comments on commit c9388e7

Please sign in to comment.