Run HashiCorp Boundary as part of your GitHub Actions Workflow
MPL-2.0 License
setup-boundary
The hashicorp/setup-boundary
Action sets up the Boundary CLI in your GitHub Actions workflow by adding the boundary
binary to PATH
.
Create a GitHub Actions Workflow file (e.g.: .github/workflows/boundary.yml
):
name: boundary
on:
push:
env:
PRODUCT_VERSION: "0.16.0"
jobs:
boundary:
runs-on: ubuntu-latest
name: Run Boundary
steps:
- name: Setup `boundary`
uses: hashicorp/setup-boundary@main
id: setup
with:
version: "latest"
- name: Run `boundary connect`
id: connect
run: "boundary connect -target-id ttcp_1234567890"
In the above example, the following definitions have been set.
push
. For a complete list, see Events that trigger workflows.hashicorp/setup-boundary@main
. For newer versions, see the Releases.boundary
to set up has been set as 0.16.0
. For a complete list, see releases.hashicorp.com.ttcp_1234567890
.[!NOTE] To retrieve the
latest
version, this GitHub Action polls the HashiCorp Releases API and finds the latest released version of Boundary that isn't marked as a pre-release (is_prerelease
).
These definitions may require updating to suit your deployment, such as specifying self-hosted runners.
Additionally, you may configure outputs to consume return values from the Action's operations.
The action can be run on ubuntu-latest
, windows-latest
, and macos-latest
GitHub Actions runners.
[!IMPORTANT] When running on
windows-latest
the shell must be set tobash
.
This section contains a list of all inputs that may be set for this Action.
version
- The version of boundary
to install. Defaults to latest
if unset.This section contains a list of all outputs that can be consumed from this Action.
version
- The version of boundary
that was installed.Licensed under the Mozilla Public License, Version 2.0 (the "License").
See the License for the specific language governing permissions and limitations under the License.