quokka/.github/workflows/codeql.yml at beff506c19ac1bdf77b5bcceb1647d2dac96502a · quokka-astro/quokka · 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
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
name: 🔒 CodeQL

on:
  push:
    branches: [ "development" ]
  pull_request:
    branches: [ "development" ]
  schedule:
    - cron: "27 3 * * 0"

concurrency:
  group: ${{ github.ref }}-${{ github.head_ref }}-codeql
  cancel-in-progress: true

permissions:
  contents: read

jobs:
  check-changes:
    runs-on: ubuntu-latest
    outputs:
      code-changed: ${{ steps.changes.outputs.code }}
    steps:
      - uses: actions/checkout@v6
      - uses: dorny/paths-filter@v3
        id: changes
        with:
          filters: |
            code:
              - 'src/**'
              - 'extern/amrex/**'
              - 'extern/Microphysics/**'
              - 'extern/fmt/**'
              - 'extern/grackle_data_files/**'
              - 'extern/openPMD-api/**'
              - 'extern/yaml-cpp/**'
              - 'extern/turbulence/**'
              - 'inputs/**'
              - 'CMakeLists.txt'
              - '**/*.cpp'
              - '**/*.c'
              - '**/*.hpp'
              - '**/*.h'
              - '.github/workflows/codeql.yml'
              - '.github/workflows/codeql/codeql-config.yml'

  analyze:
    needs: check-changes
    if: ${{ needs.check-changes.outputs.code-changed == 'true' && (github.repository == 'quokka-astro/quokka' || github.event_name != 'schedule') }}
    name: Analyze
    runs-on: ubuntu-latest
    permissions:
      actions: read
      contents: read
      security-events: write
    strategy:
      fail-fast: false
      matrix:
        language: [ python ]
    steps:
      - name: Checkout
        uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v4.2.2
        with:
          submodules: true
          fetch-depth: 0

      - name: Install Packages (C++)
        if: ${{ matrix.language == 'cpp' }}
        run: |
          sudo apt-get update
          sudo apt-get install --yes cmake openmpi-bin libopenmpi-dev libhdf5-openmpi-dev
          .github/workflows/dependencies/dependencies_ccache.sh
          sudo ln -s /usr/local/bin/ccache /usr/local/bin/g++

      - name: Set Up Cache
        if: ${{ matrix.language == 'cpp' }}
        uses: actions/cache@9255dc7a253b0ccc959486e2bca901246202afeb # v5.0.1
        with:
          path: ~/.cache/ccache
          key: ccache-${{ github.workflow }}-${{ github.job }}-git-${{ github.sha }}
          restore-keys: |
               ccache-${{ github.workflow }}-${{ github.job }}-git-

      - name: Configure (C++)
        if: ${{ matrix.language == 'cpp' }}
        run: |
          cmake -S . -B build                            \
              -DAMReX_SPACEDIM=3                         \
              -DQUOKKA_PYTHON=OFF                        \
              -DCMAKE_VERBOSE_MAKEFILE=ON                \
              -DCMAKE_CXX_COMPILER="/usr/local/bin/g++"

      - name: Initialize CodeQL
        uses: github/codeql-action/init@5d4e8d1aca955e8d8589aabd499c5cae939e33c7 # v3.29.5
        with:
          languages: ${{ matrix.language }}
          queries: +security-and-quality
          config-file: ./.github/workflows/codeql/codeql-config.yml

      - name: Build (py)
        uses: github/codeql-action/autobuild@5d4e8d1aca955e8d8589aabd499c5cae939e33c7 # v3.29.5
        if: ${{ matrix.language == 'python' }}

      - name: Build (C++)
        if: ${{ matrix.language == 'cpp' }}
        run: |
          export CCACHE_COMPRESS=1
          export CCACHE_COMPRESSLEVEL=10
          export CCACHE_MAXSIZE=30M
          ccache -z

          cmake --build build -j 4

          ccache -s
          du -hs ~/.cache/ccache

          # Make sure CodeQL has something to do
          touch src/main.cpp
          export CCACHE_DISABLE=1
          cd build
          make -j 4

      - name: Perform CodeQL Analysis
        uses: github/codeql-action/analyze@5d4e8d1aca955e8d8589aabd499c5cae939e33c7 # v3.29.5
        with:
          category: "/language:${{ matrix.language }}"

  # Critical: Always-success job for branch protection
  codeql-success:
    needs: [check-changes, analyze]
    if: always()  # Run regardless of analyze job outcome
    runs-on: ubuntu-latest
    steps:
      - name: CodeQL Status
        run: |
          if [[ "${{ needs.check-changes.outputs.code-changed }}" == "true" ]]; then
            if [[ "${{ needs.analyze.result }}" == "success" ]]; then
              echo "CodeQL analysis completed successfully"
              exit 0
            else
              echo "CodeQL analysis failed"
              exit 1
            fi
          else
            echo "CodeQL analysis skipped - no relevant code changes"
            exit 0
          fi

  save_pr_number:
    if: github.event_name == 'pull_request'
    runs-on: ubuntu-latest
    steps:
      - name: Save PR number
        env:
          PR_NUMBER: ${{ github.event.number }}
        run: |
          echo $PR_NUMBER > pr_number.txt
      - uses: actions/upload-artifact@b7c566a772e6b6bfb58ed0dc250532a479d7789f # v6.0.0
        with:
          name: pr_number
          path: pr_number.txt
          retention-days: 1