Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/enricomi/download-buildkite-artifact-action
GitHub Action to download artifacts from Buildkite.
https://github.com/enricomi/download-buildkite-artifact-action
buildkite github-actions github-workflow
Last synced: 10 days ago
JSON representation
GitHub Action to download artifacts from Buildkite.
- Host: GitHub
- URL: https://github.com/enricomi/download-buildkite-artifact-action
- Owner: EnricoMi
- License: apache-2.0
- Created: 2020-08-24T18:40:17.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2023-02-23T14:48:29.000Z (over 1 year ago)
- Last Synced: 2024-09-19T07:31:13.111Z (about 2 months ago)
- Topics: buildkite, github-actions, github-workflow
- Language: Python
- Homepage:
- Size: 160 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# GitHub Action to download Buildkite Artifacts
This [GitHub Action](https://github.com/actions) downloads artifacts from
a [Buildkite](https://buildkite.com/) pipeline that builds the respective commit.
The action picks up a Buildkite build from the commit status that is set by
[Buildkite integration with Github](https://buildkite.com/docs/integrations/github#connecting-buildkite-and-github),
which looks like this:
After termination of the Buildkite build, the action downloads finished artifacts into your GitHub workflow
where you can use them in other steps and jobs.
You can add this action to your GitHub workflow for  (e.g. `runs-on: ubuntu-latest`) runners:
```yaml
- name: Buildkite Artifacts
uses: EnricoMi/download-buildkite-artifact-action@v1
with:
buildkite_token: ${{ secrets.BUILDKITE_TOKEN }}
output_path: artifacts
```
Use this for  (e.g. `runs-on: macos-latest`)
and  (e.g. `runs-on: windows-latest`) runners:
```yaml
- name: Buildkite Artifacts
uses: EnricoMi/download-buildkite-artifact-action/composite@v1
with:
buildkite_token: ${{ secrets.BUILDKITE_TOKEN }}
output_path: artifacts
```
### Trigger a build and download its artifacts
You can trigger a Buildkite build with the [buildkite/trigger-pipeline-action](https://github.com/buildkite/trigger-pipeline-action) action
and then download the artifacts from that build:
```yaml
steps:
- name: Trigger Buildkite Pipeline
id: build
uses: buildkite/[email protected]
env:
PIPELINE: "/"
BUILDKITE_API_ACCESS_TOKEN: ${{ secrets.BUILDKITE_TOKEN }}
- name: Download Buildkite Artifacts
uses: EnricoMi/download-buildkite-artifact-action@v1
with:
buildkite_token: ${{ secrets.BUILDKITE_TOKEN }}
buildkite_build_url: ${{ steps.build.outputs.url }}
ignore_build_states: blocked,canceled,skipped,not_run
ignore_job_states: timed_out,failed
output_path: artifacts
```
## Permissions
It is generally good practice to [restrict permissions for actions in your workflows and jobs](https://docs.github.com/en/actions/using-jobs/assigning-permissions-to-jobs) to the required minimum.
When `buildkite_build_url` is provided, no permissions are needed by this action at all:
```yaml
permissions: {}
```
When `buildkite_build_url` is **not** provided, the action picks up any Buildkite check created by
[Buildkite integration with Github](https://buildkite.com/docs/integrations/github#connecting-buildkite-and-github).
Then, the following permissions are required:
```yaml
permissions:
metadata: read
contents: read
statuses: read
```
## Configuration
The `output_path` and `log_level` variables are optional. Their default values are `.` (current directory) and `INFO`, respectively. The Python logging module defines the [available log levels](https://docs.python.org/3/library/logging.html#logging-levels).
You have to provide a [Buildkite API Access Token](https://buildkite.com/docs/apis/managing-api-tokens) via `buildkite_token` to be stored in your [GitHub secrets](https://docs.github.com/en/actions/configuring-and-managing-workflows/creating-and-storing-encrypted-secrets).
This Buildkite token requires `read_artifacts` and `read_builds` scopes:
Artifacts are stored under the following path: `{output_path}/{job_name}/{artifact_path}`
- The `output_path` is a configured above or defaults to the current directory.
- The `job_name` avoids conflicts between artifacts that have the same `artifact_path` in different jobs.
- The `artifact_path` is the path and filename for the artifact as displayed on the Buildkite build page:
## Outputs
The action provides the following outputs:
|output |description |
|--------------|---------------------------------|
|`build-number`|The number of the Buildkite build|
|`build-state`|The state of the Buildkite build: `passed`, `failed`, `blocked`, `canceled`, `skipped`, `not_run` |
|`download-state`|The outcome of downloading artifacts: `skipped`, `success`, `failure`|
|`download-paths`|The paths of the downloaded artifacts as a Json array of strings|
|`download-files`|The number of downloaded files|