civiform/.github/workflows/pr_env_var_docs.yaml at main · civiform/civiform · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
name: Env Variable Docs - Validate

# Cancels in-progress jobs on this pull request when new commits are pushed.
# This avoids wasted work for old commits.
concurrency:
  group: pr-env-var-docs-${{ github.head_ref || github.run_id }}
  cancel-in-progress: true

on:
  pull_request:
    branches-ignore:
      - 'spike/**'
    paths:
      - 'env-var-docs/**'
      - 'server/conf/env-var-docs.json'
      - 'server/conf/application.conf'
      - 'server/conf/helper/*.conf'
      - '.github/workflows/pr_env_var_docs.yaml'

permissions:
  contents: read

jobs:
  run-validations:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6

      - uses: actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # v6
        with:
          python-version: '3.13'

      - name: Run tests
        run: bin/env-var-docs-run-tests

      - name: Upload coverage to Codecov
        uses: codecov/codecov-action@fb8b3582c8e4def4969c97caa2f19720cb33a72f # v6
        env:
          CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
        with:
          verbose: true
          files: coverage.xml
          # We're getting intermittent issues with codecov trying to upload lately
          # disabling it from failing the entire pipeline for now.
          fail_ci_if_error: false

      - name: Check environment variables
        run: bin/env-var-docs-check-vars