mirror of https://github.com/hashicorp/setup-boundary synced 2026-04-05 19:09:27 +00:00

No description

TypeScript 100%

Find a file

Sagar Verma b3b2502d24 Update copyright holder in action.yml		2026-03-24 12:16:26 +05:30
.github	Update copyright from HashiCorp to IBM Corp	2026-03-24 12:16:26 +05:30
dist	cleans up dependencies and docs	2024-05-08 09:35:26 +02:00
images	docs: add HashiCorp Boundary logo	2024-04-23 22:29:42 +02:00
src	Update copyright notice from HashiCorp to IBM Corp	2026-03-24 12:16:26 +05:30
.copywrite.hcl	linting	2024-04-24 17:28:53 +02:00
.gitignore	updates workflows	2024-05-08 09:35:26 +02:00
.prettierrc.json	feat: initial release	2024-04-23 19:37:25 +02:00
action.yml	Update copyright holder in action.yml	2026-03-24 12:16:26 +05:30
CODE_OF_CONDUCT.md	docs: add code of conduct and fix indent	2024-04-23 23:02:21 +02:00
CODEOWNERS	Update CODEOWNERS	2024-05-10 14:21:29 +02:00
LICENSE	legal: change to MPL-2.0	2024-04-23 19:47:04 +02:00
package-lock.json	build(deps-dev): bump @types/semver from 7.5.8 to 7.7.0	2025-03-31 22:24:59 +02:00
package.json	build(deps-dev): bump @types/semver from 7.5.8 to 7.7.0	2025-03-31 22:24:59 +02:00
README.md	cleans up dependencies and docs	2024-05-08 09:35:26 +02:00
tsconfig.json	feat: initial release	2024-04-23 19:37:25 +02:00

README.md

GitHub Action: `setup-boundary`

The hashicorp/setup-boundary Action sets up the Boundary CLI in your GitHub Actions workflow by adding the boundary binary to PATH.

GitHub Action: setup-boundary
- Usage
  - OS Support
- Inputs
- Outputs
- License
- Code of Conduct

Usage

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.

The event trigger has been set to push. For a complete list, see Events that trigger workflows.
The origin of this GitHub Action has been set as hashicorp/setup-boundary@main. For newer versions, see the Releases.
The version of boundary to set up has been set as 0.16.0. For a complete list, see releases.hashicorp.com.
The Boundary Target to interact with has been set as 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.

OS Support

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 to bash.

Inputs

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.

Outputs

This section contains a list of all outputs that can be consumed from this Action.

version - The version of boundary that was installed.

License

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.