Updated documentation for Buildkite package registry #819
+38
−0
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -24,6 +24,7 @@ ___ | |
| * [OCI Oracle Cloud Infrastructure Registry (OCIR)](#oci-oracle-cloud-infrastructure-registry-ocir) | ||
| * [Quay.io](#quayio) | ||
| * [DigitalOcean](#digitalocean-container-registry) | ||
| * [Buildkite Packages](#buildkite-package-registry) | ||
| * [Customizing](#customizing) | ||
| * [inputs](#inputs) | ||
| * [Contributing](#contributing) | ||
|
|
@@ -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 | ||
|
|
||
| ```yaml | ||
| name: ci | ||
|
|
||
| on: | ||
| push: | ||
| branches: main | ||
|
|
||
| jobs: | ||
| login: | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - | ||
| name: Login to Buildkite Package Registry | ||
| 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 |
||
| password: ${{ secrets.BUILDKITE_ACCESS_TOKEN }} | ||
| ``` | ||
| **Useful references:** | ||
| [Buildkite package Registry](https://buildkite.com/docs/package-registries) | ||
|
Comment on lines
+521
to
+522
There was a problem hiding this comment. This is not consistent with other examples. Let's keep the same layout. |
||
|
|
||
| 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 | ||
| ``` | ||
|
Comment on lines
+524
to
+534
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. |
||
| ## Customizing | ||
|
|
||
| ### inputs | ||
|
|
||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks like a typo here:
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: