From 88836fcb054c329f364fd1e204325157d2aa5f7d Mon Sep 17 00:00:00 2001 From: Pawel Lampe Date: Mon, 27 Nov 2023 23:04:13 +0100 Subject: [PATCH] Add README section describing GitHub action usage, closes #243 --- README.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/README.md b/README.md index 471a0864..267dcc79 100644 --- a/README.md +++ b/README.md @@ -133,6 +133,32 @@ tests/gd2py/input-output-pairs/func-level-statements.in.gd F 1:0 foo - B (8) ``` +## Using gdtoolkit's GitHub action + +In order to setup a simple action with gdtoolkit's static checks, the base action from this repo can be used: + +``` +name: Static checks + +on: + push: + branches: [ "main" ] + pull_request: + branches: [ "main" ] + +jobs: + static-checks: + name: 'Static checks' + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v3 + - uses: Scony/godot-gdscript-toolkit@master + - run: gdformat --check source/ + - run: gdlint source/ +``` + +See the discussion in https://github.com/Scony/godot-gdscript-toolkit/issues/239 for more details. + ## Development [(more)](https://github.com/Scony/godot-gdscript-toolkit/wiki/5.-Development) Everyone is free to fix bugs or introduce new features. For that, however, please refer to existing issue or create one before starting implementation.