Skip to content

Commit ce17d7b

Browse files
committed
feat: document github action
1 parent 9eb444a commit ce17d7b

1 file changed

Lines changed: 28 additions & 0 deletions

File tree

README.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -112,6 +112,34 @@ Run directly without installation:
112112
nix run github:brainhivenl/steiger -- build
113113
```
114114

115+
### Using GitHub Actions
116+
117+
Use the official GitHub Action in your workflows:
118+
119+
```yaml
120+
name: Build and Deploy
121+
on:
122+
push:
123+
branches: [main]
124+
125+
jobs:
126+
build:
127+
runs-on: ubuntu-latest
128+
steps:
129+
- uses: actions/checkout@v4
130+
- uses: brainhivenl/steiger-action@v1
131+
with:
132+
cmd: build
133+
args: --repo ghcr.io/my-org/my-project
134+
version: v0.0.1
135+
```
136+
137+
The action supports these inputs:
138+
139+
- `cmd` (required): The steiger command to run (default: `build`)
140+
- `args` (optional): Arguments to pass to the command
141+
- `version` (optional): Version of steiger to use (default: `v0.0.1`)
142+
115143
### Build from source
116144

117145
```bash

0 commit comments

Comments
 (0)