https://github.com/bruin-data/setup-bruin
Official action to install Bruin CLI in Github Actions.
https://github.com/bruin-data/setup-bruin
actions cli data-engineering data-management golang
Last synced: about 1 month ago
JSON representation
Official action to install Bruin CLI in Github Actions.
- Host: GitHub
- URL: https://github.com/bruin-data/setup-bruin
- Owner: bruin-data
- Created: 2024-11-01T12:16:58.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2025-02-04T15:36:04.000Z (5 months ago)
- Last Synced: 2025-04-02T05:13:20.945Z (3 months ago)
- Topics: actions, cli, data-engineering, data-management, golang
- Language: TypeScript
- Homepage: https://github.com/bruin-data/bruin
- Size: 700 KB
- Stars: 2
- Watchers: 4
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# `setup-bruin`
This [Action](https://github.com/marketplace/actions/bruin-setup) installs the [`bruin`](https://github.com/bruin-data/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`:
```yaml
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`](https://github.com/bruin-data/bruin) to install | [`latest`](https://github.com/bruin-data/bruin/releases) |
> These parameters are derived from [`action.yml`](./action.yml).
#### Version
If `version` is unspecified, the latest version of `bruin` is installed:
```yaml
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:
```yaml
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:
```yaml
steps:
- uses: actions/checkout@v2
- uses: bruin-data/setup-bruin@main
with:
version: latest
- run: bruin --version
```
Example
```yaml
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
```