Skip to content

Commit 88836fc

Browse files
committed
Add README section describing GitHub action usage, closes Scony#243
1 parent 8b66d13 commit 88836fc

File tree

1 file changed

+26
-0
lines changed

1 file changed

+26
-0
lines changed

README.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -133,6 +133,32 @@ tests/gd2py/input-output-pairs/func-level-statements.in.gd
133133
F 1:0 foo - B (8)
134134
```
135135

136+
## Using gdtoolkit's GitHub action
137+
138+
In order to setup a simple action with gdtoolkit's static checks, the base action from this repo can be used:
139+
140+
```
141+
name: Static checks
142+
143+
on:
144+
push:
145+
branches: [ "main" ]
146+
pull_request:
147+
branches: [ "main" ]
148+
149+
jobs:
150+
static-checks:
151+
name: 'Static checks'
152+
runs-on: ubuntu-latest
153+
steps:
154+
- uses: actions/checkout@v3
155+
- uses: Scony/godot-gdscript-toolkit@master
156+
- run: gdformat --check source/
157+
- run: gdlint source/
158+
```
159+
160+
See the discussion in https://github.com/Scony/godot-gdscript-toolkit/issues/239 for more details.
161+
136162
## Development [(more)](https://github.com/Scony/godot-gdscript-toolkit/wiki/5.-Development)
137163

138164
Everyone is free to fix bugs or introduce new features. For that, however, please refer to existing issue or create one before starting implementation.

0 commit comments

Comments
 (0)