Skip to content

Commit

Permalink
Merge pull request buildkite#48 from buildkite/release-1.6.0
Browse files Browse the repository at this point in the history
Update version to 1.6.0
  • Loading branch information
lizrabuya authored Jun 2, 2023
2 parents 7130540 + 6b5a83d commit b1bb995
Showing 1 changed file with 18 additions and 11 deletions.
29 changes: 18 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,14 +11,19 @@ A [GitHub Action](https://github.com/actions) for triggering a build on a [Build

Create a [Buildkite API Access Token](https://buildkite.com/docs/apis/rest-api#authentication) with `write_builds` scope, and save it to your GitHub repository’s **Settings → Secrets**. Then you can configure your Actions workflow with the details of the pipeline to be triggered, and the settings for the build.


## Configuration Options

### Configuration as Environment Variables

For example, the following workflow creates a new Buildkite build on every commit by setting environment variables:

```
on: [push]
steps:
- name: Trigger a Buildkite Build
uses: "buildkite/trigger-pipeline-action@v1.5.0"
uses: "buildkite/trigger-pipeline-action@v1.6.0"
env:
BUILDKITE_API_ACCESS_TOKEN: ${{ secrets.TRIGGER_BK_BUILD_TOKEN }}
PIPELINE: "my-org/my-deploy-pipeline"
Expand All @@ -27,7 +32,7 @@ steps:
MESSAGE: ":github: Triggered from a GitHub Action"
```

## Configuration Options


The following environment variable options can be configured:

Expand All @@ -40,16 +45,8 @@ The following environment variable options can be configured:
|BUILD_ENV_VARS|Additional environment variables to set on the build, in JSON format. e.g. `{"FOO": "bar"}`. Optional. ||
|BUILD_META_DATA|Meta data to set on the build, in JSON format. e.g. `{"FOO": "bar"}`. Optional. ||
|IGNORE_PIPELINE_BRANCH_FILTER | Ignore pipeline branch filtering when creating a new build. true or false. Optional. ||
## Outputs

The following outputs are provided by the action:

|Output var|Description|
|-|-|
|url|The URL of the Buildkite build.|
|json|The JSON response returned by the Buildkite API.|

## Configuration as Input Parameters
### Configuration as Input Parameters

From v1.6.0, optional input parameters can now be used to pass in the configuration options. However, configuration defined as environment variables take precedence over the input parameters.

Expand All @@ -70,6 +67,16 @@ steps:
ignore-pipeline-branch-filter: true
```

## Outputs

The following outputs are provided by the action:

|Output var|Description|
|-|-|
|url|The URL of the Buildkite build.|
|json|The JSON response returned by the Buildkite API.|


## Development

To run the test workflow, you use [act](https://github.com/nektos/act) which will run it just as it does on GitHub:
Expand Down

0 comments on commit b1bb995

Please sign in to comment.