Merge pull request #9 from CubicrootXYZ/jinja-validator

add jinja validate workflow

.github/workflows/jinja.yaml

@@ -0,0 +1,25 @@
+on:
+  workflow_call:
+    inputs:
+      workdir:
+        required: false
+        default: "./"
+        type: string
+
+jobs:
+  validate:
+    runs-on: ubuntu-latest
+    if: "!startsWith(github.ref, 'refs/tags/')"
+    container:
+      image: cubicrootxyz/jinja:v0.0.3
+      options: --user root
+    steps:
+      - name: Checkout the repository
+        uses: actions/checkout@v4
+        with:
+          ref: ${{ github.head_ref }}
+      - run: git config --global --add safe.directory "$GITHUB_WORKSPACE"
+      - name: Run tests
+        run: (cd ${{ inputs.workdir }} && makejinja)
+      - name: Check for diffs
+        run: git diff --exit-code

.github/workflows/jinja_test.yaml

@@ -0,0 +1,7 @@
+on: push
+
+jobs:
+  jinja:
+    uses: ./.github/workflows/jinja.yaml
+    with:
+      workdir: "tests/jinja/" 

README.md

@@ -50,4 +50,18 @@ jobs:
       workdir: "tests/golang_test/"
       services: '{"database": {"image": "mysql:8.0", "ports": ["3306:3306"]}}'
       env: '{"TESTENV": "value"}'
+```
+
+## Jinja
+
+### Validate generates are up to date
+
+Add the following job to your CI to ensure `jinja` generated files are always up to date. Uses `makejinja` for templating.
+
+```yaml
+jobs:
+  jinja:
+    uses: CubicrootXYZ/Workflows/.github/workflows/[email protected]
+    with:
+      workdir: "tests/jinja/"
 ```

tests/jinja/generated/testfile.yml

@@ -0,0 +1,3 @@
+- a
+- b
+- c

tests/jinja/makejinja.toml

@@ -0,0 +1,3 @@
+[makejinja]
+inputs = ["./templates"]
+output = "./generated"

tests/jinja/templates/testfile.yml.jinja

@@ -0,0 +1,3 @@
+{% for item in ["a", "b", "c"] %}
+- {{ item }}
+{% endfor %}