Updated documentation for Buildkite package registry #819
Conversation
updated readme to include buildkite packages Signed-off-by: Adrian Lee <[email protected]>
Signed-off-by: Adrian Lee <[email protected]>
Updated docs for buildkite package registry Signed-off-by: Adrian Lee <[email protected]>
| uses: docker/login-action@v3 | ||
| with: | ||
| registry: packages.buildkite.com | ||
| username: buildkite #All usernames to buildkite packages is "buildkite". |
There was a problem hiding this comment.
Don't inline comment also doesn't look necessary as this is documented in buildkite docs already: https://buildkite.com/docs/package-registries/container#publish-an-image
| **Useful references:** | ||
| [Buildkite package Registry](https://buildkite.com/docs/package-registries) |
There was a problem hiding this comment.
This is not consistent with other examples. Let's keep the same layout.
| @@ -494,6 +495,43 @@ jobs: | |||
| password: ${{ secrets.DIGITALOCEAN_ACCESS_TOKEN }} | |||
| ``` | |||
|
|
|||
| ### Buildkite Package Registry | |||
|
|
|||
| Use your Buildkite registered email address to generate an API access token to authenticate. U | |||
There was a problem hiding this comment.
Looks like a typo here:
| Use your Buildkite registered email address to generate an API access token to authenticate. U | |
| Use your Buildkite registered email address to generate an API access token to authenticate. |
Also this looks like a copy/paste of DigitalOcean example and does not seem accurate looking at Buildkite docs. I think the following would be better to be consistent with other examples related to my previous comment:
| Use your Buildkite registered email address to generate an API access token to authenticate. U | |
| Configure [API access token](https://buildkite.com/user/api-access-tokens) to login to [Buildkite Package Registries](https://buildkite.com/docs/package-registries/container). Ensure this access token has the **Read Packages** and **Write Packages** REST API scopes. |
| Go to your Buildkite Org/Buildkite Package registry to generate a token | ||
|
|
||
| **Working pipeline example:** [https://gist.github.com/kleeadrian/f096878f76b5fb759976adce9550c9a5](https://gist.github.com/kleeadrian/f096878f76b5fb759976adce9550c9a5) | ||
|
|
||
| **Scope required:** | ||
| ``` | ||
| read_registries | ||
| write_registries | ||
| read_packages | ||
| write_packages | ||
| ``` |
There was a problem hiding this comment.
Not needed based on my previous comment also we don't want to provide pipeline examples as the snippet here is enough to get started.
Added supported, instructions and steps on how to leverage GitHub Actions to push packages to Buildkite package registry.