Skip to content

bruin-data/setup-bruin

Use this GitHub action with your project
Add this Action to an existing workflow or create a new one
View on Marketplace

Repository files navigation

setup-bruin

This Action installs the bruin CLI in your GitHub Actions pipelines so that it can be used by other Bruin Actions:

After setup-bruin is run, the bruin command is available to other Actions in the pipeline's PATH. You can also use the bruin command directly inside of workflow steps.

Usage

Here's an example usage of setup-bruin:

steps:
  # Run `git checkout`
  - uses: actions/checkout@v2
  # Install the `bruin` CLI
  - uses: bruin-data/setup-bruin@main
  # Ensure that `bruin` is installed
  - run: bruin --version

Configuration

Input

You can configure setup-bruin with these parameters:

Parameter Description Default
version The version of the bruin to install latest

These parameters are derived from action.yml.

Version

If version is unspecified, the latest version of bruin is installed:

steps:
  - uses: actions/checkout@v2
  # Installs latest
  - uses: bruin-data/setup-bruin@main
  - run: bruin --version

Use the version parameter to pin to a specific version:

steps:
  - uses: actions/checkout@v2
  # Installs version 0.11.52
  - uses: bruin-data/setup-bruin@main
    with:
      version: 0.11.52
  # Should output 0.11.52
  - run: bruin --version

To resolve the latest release from GitHub, you can specify latest, but this is not recommended:

steps:
  - uses: actions/checkout@v2
  - uses: bruin-data/setup-bruin@main
    with:
      version: latest
  - run: bruin --version

Example

jobs:
  linux:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v2
    # Installs latest
    - uses: bruin-data/setup-bruin@main
    - run: bruin validate ./bruin-pipeline/
      name: Validate Pipeline
    - run: bruin format ./bruin-pipeline/
      name: Format Pipeline
    - name: Lineage
      run: |
        bruin lineage bruin-pipeline/assets/example.sql
        bruin lineage bruin-pipeline/assets/pythonsample/country_list.py