Skip to content

chore: minor edits to readme and action.yml #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
zeroshade merged 6 commits into from
Apr 13, 2026
Merged

chore: minor edits to readme and action.yml #2

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
35aaef8
Use checkout@v6
amoeba Apr 13, 2026
5e9115e
Fix bad link to dbc, just call dbc "dbc" not "dbc CLI"
amoeba Apr 13, 2026
71e4a8d
Tweak wording in readme tag line
amoeba Apr 13, 2026
15a2675
Add link to private drivers guide
amoeba Apr 13, 2026
0bdcf25
Tweak driver list usage structure
amoeba Apr 13, 2026
4ea1367
Change action author to Columnar
amoeba Apr 13, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 20 additions & 10 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Setup dbc Action

GitHub Action to install the [dbc CLI](https://dbc.columnar.tech), authenticate with optional API key, and install drivers.
GitHub Action to set up [dbc](https://columnar.tech/dbc) and install drivers in CI.

## Features

Expand All @@ -19,7 +19,7 @@ Install the latest version of dbc CLI:

```yaml
steps:
- uses: actions/checkout@v4
- uses: actions/checkout@v6
- uses: columnar-tech/setup-dbc@v1
- run: dbc --version
```
Expand Down Expand Up @@ -48,7 +48,7 @@ steps:

### With Private Drivers

Authenticate with API key for private drivers:
Authenticate with API key for [private drivers](https://docs.columnar.tech/dbc/guides/private_drivers/):

```yaml
steps:
Expand All @@ -58,23 +58,33 @@ steps:
drivers: 'oracle,teradata,postgresql'
```

### Using Config File
### Installing Drivers From A Driver List

Install drivers from a `dbc.toml` file:
If `dbc.toml` is present at the workspace root, the action will run `dbc sync` automatically:

```yaml
steps:
- uses: actions/checkout@v4
- uses: actions/checkout@v6
- uses: columnar-tech/setup-dbc@v1
```

The above is equivalent to:

```yaml
steps:
- uses: actions/checkout@v6
- uses: columnar-tech/setup-dbc@v1
with:
driver-list-file: 'dbc.toml'
```

### Custom Config File Path
See [Using a Driver List](https://docs.columnar.tech/dbc/guides/driver_list/) to learn more about driver list files.

### Custom Driver List Path

```yaml
steps:
- uses: actions/checkout@v4
- uses: actions/checkout@v6
- uses: columnar-tech/setup-dbc@v1
with:
driver-list-file: 'config/custom-dbc.toml'
Expand Down Expand Up @@ -135,7 +145,7 @@ jobs:
test:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/checkout@v6

- uses: columnar-tech/setup-dbc@v1
with:
Expand All @@ -161,7 +171,7 @@ jobs:
driver: [postgresql, mysql, sqlite]
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/checkout@v6

- uses: columnar-tech/setup-dbc@v1
with:
Expand Down
2 changes: 1 addition & 1 deletion action.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
name: 'Setup DBC'
description: 'Install dbc CLI, authenticate, and install drivers'
author: 'zeroshade'
author: 'Columnar'

inputs:
version:
Expand Down