Skip to content

Commit 236a6cb

Browse files
chore: add readme (#3)
1 parent a3e440c commit 236a6cb

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

README.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# PostgresTools GitHub Action
2+
3+
This is a simple action that will install [PostgresTools](https://github.com/supabase-community/postgres_lsp) on your runner. It will install the appropriate binary for your machine.
4+
5+
It has a single input: `version: latest | <semver>`.
6+
Use `latest` if you want to use the latest available version in your runner.
7+
Use a specific tag, such as `0.2.0`, if you want to use a specific version.
8+
9+
Whatever version is used will be output as `outputs.installed-version`.
10+
11+
## Example Usage
12+
13+
```yaml
14+
jobs:
15+
lint:
16+
runs-on: ubuntu-latest
17+
steps:
18+
- uses: actions/checkout@v4
19+
- uses: supabase-community/pglt-cli-action@1
20+
with:
21+
version: 0.2.0
22+
- run: postgrestools check --skip-db test.sql
23+
```

0 commit comments

Comments
 (0)