|
| 1 | +--- |
| 2 | +# For most projects, this workflow file will not need changing; you simply need |
| 3 | +# to commit it to your repository. |
| 4 | +# |
| 5 | +# You may wish to alter this file to override the set of languages analyzed, |
| 6 | +# or to provide custom queries or build logic. |
| 7 | +name: CodeQL |
| 8 | + |
| 9 | +# The use of on here as a key is part of the GitHub actions syntax. |
| 10 | +# yamllint disable-line rule:truthy |
| 11 | +on: |
| 12 | + merge_group: |
| 13 | + types: |
| 14 | + - checks_requested |
| 15 | + pull_request: |
| 16 | + # The branches here must be a subset of the ones in the push key |
| 17 | + branches: |
| 18 | + - develop |
| 19 | + push: |
| 20 | + # Dependabot-triggered push events have read-only access, but uploading code |
| 21 | + # scanning requires write access. |
| 22 | + branches-ignore: |
| 23 | + - dependabot/** |
| 24 | + schedule: |
| 25 | + - cron: 0 2 * * 6 |
| 26 | + |
| 27 | +jobs: |
| 28 | + diagnostics: |
| 29 | + name: Run diagnostics |
| 30 | + # This job does not need any permissions |
| 31 | + permissions: {} |
| 32 | + runs-on: ubuntu-latest |
| 33 | + steps: |
| 34 | + # Note that a duplicate of this step must be added at the top of |
| 35 | + # each job. |
| 36 | + - name: Apply standard cisagov job preamble |
| 37 | + uses: cisagov/action-job-preamble@v1 |
| 38 | + with: |
| 39 | + check_github_status: "true" |
| 40 | + # This functionality is poorly implemented and has been |
| 41 | + # causing problems due to the MITM implementation hogging or |
| 42 | + # leaking memory. As a result we disable it by default. If |
| 43 | + # you want to temporarily enable it, simply set |
| 44 | + # monitor_permissions equal to "true". |
| 45 | + # |
| 46 | + # TODO: Re-enable this functionality when practical. See |
| 47 | + # cisagov/skeleton-generic#207 for more details. |
| 48 | + monitor_permissions: "false" |
| 49 | + output_workflow_context: "true" |
| 50 | + # Use a variable to specify the permissions monitoring |
| 51 | + # configuration. By default this will yield the |
| 52 | + # configuration stored in the cisagov organization-level |
| 53 | + # variable, but if you want to use a different configuration |
| 54 | + # then simply: |
| 55 | + # 1. Create a repository-level variable with the name |
| 56 | + # ACTIONS_PERMISSIONS_CONFIG. |
| 57 | + # 2. Set this new variable's value to the configuration you |
| 58 | + # want to use for this repository. |
| 59 | + # |
| 60 | + # Note in particular that changing the permissions |
| 61 | + # monitoring configuration *does not* require you to modify |
| 62 | + # this workflow. |
| 63 | + permissions_monitoring_config: ${{ vars.ACTIONS_PERMISSIONS_CONFIG }} |
| 64 | + analyze: |
| 65 | + name: Analyze |
| 66 | + needs: |
| 67 | + - diagnostics |
| 68 | + runs-on: ubuntu-latest |
| 69 | + permissions: |
| 70 | + # actions/checkout needs this to fetch code |
| 71 | + contents: read |
| 72 | + # required for all workflows |
| 73 | + security-events: write |
| 74 | + strategy: |
| 75 | + fail-fast: false |
| 76 | + matrix: |
| 77 | + # Override automatic language detection by changing the below |
| 78 | + # list |
| 79 | + # |
| 80 | + # Supported options are actions, c-cpp, csharp, go, |
| 81 | + # java-kotlin, javascript-typescript, python, ruby, and swift. |
| 82 | + language: |
| 83 | + - actions |
| 84 | + # Learn more... |
| 85 | + # https://docs.github.com/en/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning#overriding-automatic-language-detection |
| 86 | + |
| 87 | + steps: |
| 88 | + - name: Apply standard cisagov job preamble |
| 89 | + uses: cisagov/action-job-preamble@v1 |
| 90 | + with: |
| 91 | + # This functionality is poorly implemented and has been |
| 92 | + # causing problems due to the MITM implementation hogging or |
| 93 | + # leaking memory. As a result we disable it by default. If |
| 94 | + # you want to temporarily enable it, simply set |
| 95 | + # monitor_permissions equal to "true". |
| 96 | + # |
| 97 | + # TODO: Re-enable this functionality when practical. See |
| 98 | + # cisagov/skeleton-generic#207 for more details. |
| 99 | + monitor_permissions: "false" |
| 100 | + # Use a variable to specify the permissions monitoring |
| 101 | + # configuration. By default this will yield the |
| 102 | + # configuration stored in the cisagov organization-level |
| 103 | + # variable, but if you want to use a different configuration |
| 104 | + # then simply: |
| 105 | + # 1. Create a repository-level variable with the name |
| 106 | + # ACTIONS_PERMISSIONS_CONFIG. |
| 107 | + # 2. Set this new variable's value to the configuration you |
| 108 | + # want to use for this repository. |
| 109 | + # |
| 110 | + # Note in particular that changing the permissions |
| 111 | + # monitoring configuration *does not* require you to modify |
| 112 | + # this workflow. |
| 113 | + permissions_monitoring_config: ${{ vars.ACTIONS_PERMISSIONS_CONFIG }} |
| 114 | + |
| 115 | + - name: Checkout repository |
| 116 | + uses: actions/checkout@v4 |
| 117 | + |
| 118 | + # Initializes the CodeQL tools for scanning. |
| 119 | + - name: Initialize CodeQL |
| 120 | + uses: github/codeql-action/init@v3 |
| 121 | + with: |
| 122 | + languages: ${{ matrix.language }} |
| 123 | + |
| 124 | + # Autobuild attempts to build any compiled languages (C/C++, C#, or |
| 125 | + # Java). If this step fails, then you should remove it and run the build |
| 126 | + # manually (see below). |
| 127 | + - name: Autobuild |
| 128 | + uses: github/codeql-action/autobuild@v3 |
| 129 | + |
| 130 | + # ℹ️ Command-line programs to run using the OS shell. |
| 131 | + # 📚 https://git.io/JvXDl |
| 132 | + |
| 133 | + # ✏️ If the Autobuild fails above, remove it and uncomment the following |
| 134 | + # three lines and modify them (or add more) to build your code if your |
| 135 | + # project uses a compiled language |
| 136 | + |
| 137 | + # - run: | |
| 138 | + # make bootstrap |
| 139 | + # make release |
| 140 | + |
| 141 | + - name: Perform CodeQL Analysis |
| 142 | + uses: github/codeql-action/analyze@v3 |
0 commit comments