CodeQL Advanced #461
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| # For most projects, this workflow file will not need changing; you simply need | |
| # to commit it to your repository. | |
| # | |
| # You may wish to alter this file to override the set of languages analyzed, | |
| # or to provide custom queries or build logic. | |
| # | |
| # ******** NOTE ******** | |
| # We have attempted to detect the languages in your repository. Please check | |
| # the `language` matrix defined below to confirm you have the correct set of | |
| # supported CodeQL languages. | |
| # | |
| name: "CodeQL Advanced" | |
| on: | |
| push: | |
| branches: ['**'] | |
| pull_request: | |
| branches: ['**'] | |
| schedule: | |
| - cron: '25 7 * * 0' | |
| jobs: | |
| analyze: | |
| name: Analyze (${{ matrix.language }}) | |
| # Runner size impacts CodeQL analysis time. To learn more, please see: | |
| # - https://gh.io/recommended-hardware-resources-for-running-codeql | |
| # - https://gh.io/supported-runners-and-hardware-resources | |
| # - https://gh.io/using-larger-runners (GitHub.com only) | |
| # Consider using larger runners or machines with greater resources for possible analysis time improvements. | |
| runs-on: ${{ (matrix.language == 'swift' && 'macos-latest') || 'ubuntu-latest' }} | |
| permissions: | |
| # required for all workflows | |
| security-events: write | |
| # required to fetch internal or private CodeQL packs | |
| packages: read | |
| # only required for workflows in private repositories | |
| actions: read | |
| contents: read | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| include: | |
| - language: actions | |
| build-mode: none | |
| - language: java-kotlin | |
| build-mode: manual | |
| - language: python | |
| build-mode: none | |
| # CodeQL supports the following values keywords for 'language': 'actions', 'c-cpp', 'csharp', 'go', 'java-kotlin', 'javascript-typescript', 'python', 'ruby', 'rust', 'swift' | |
| # Use `c-cpp` to analyze code written in C, C++ or both | |
| # Use 'java-kotlin' to analyze code written in Java, Kotlin or both | |
| # Use 'javascript-typescript' to analyze code written in JavaScript, TypeScript or both | |
| # To learn more about changing the languages that are analyzed or customizing the build mode for your analysis, | |
| # see https://docs.github.com/en/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/customizing-your-advanced-setup-for-code-scanning. | |
| # If you are analyzing a compiled language, you can modify the 'build-mode' for that language to customize how | |
| # your codebase is analyzed, see https://docs.github.com/en/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/codeql-code-scanning-for-compiled-languages | |
| steps: | |
| - name: Checkout repository | |
| uses: actions/checkout@v4 | |
| # Add any setup steps before running the `github/codeql-action/init` action. | |
| # This includes steps like installing compilers or runtimes (`actions/setup-node` | |
| # or others). This is typically only required for manual builds. | |
| - name: Set up Java (Temurin 17) | |
| uses: actions/setup-java@v4 | |
| with: | |
| distribution: 'temurin' | |
| java-version: '17' | |
| - name: Cache Gradle packages | |
| uses: actions/cache@v4 | |
| with: | |
| path: | | |
| ~/.gradle/caches | |
| ~/.gradle/wrapper | |
| key: ${{ runner.os }}-gradle-${{ hashFiles('**/gradle-wrapper.properties') }} | |
| restore-keys: ${{ runner.os }}-gradle- | |
| - name: Install Android command-line tools and packages | |
| run: | | |
| set -e | |
| echo "Installing Android command-line tools..." | |
| mkdir -p $HOME/android-sdk/cmdline-tools | |
| TMP_ZIP="$RUNNER_TEMP/cmdline-tools.zip" | |
| curl -sSfL https://dl.google.com/android/repository/commandlinetools-linux-9477386_latest.zip -o "$TMP_ZIP" | |
| unzip -q "$TMP_ZIP" -d $HOME/android-sdk/cmdline-tools | |
| # Move contents into 'latest' as expected by sdkmanager | |
| mkdir -p $HOME/android-sdk/cmdline-tools/latest | |
| mv $HOME/android-sdk/cmdline-tools/cmdline-tools/* $HOME/android-sdk/cmdline-tools/latest/ || true | |
| export ANDROID_SDK_ROOT=$HOME/android-sdk | |
| export ANDROID_HOME=$ANDROID_SDK_ROOT | |
| export PATH=$ANDROID_SDK_ROOT/cmdline-tools/latest/bin:$ANDROID_SDK_ROOT/platform-tools:$PATH | |
| yes | sdkmanager --licenses || true | |
| sdkmanager "platform-tools" "platforms;android-33" "build-tools;33.0.2" | |
| # - name: Setup runtime (example) | |
| # uses: actions/setup-example@v1 | |
| # Initializes the CodeQL tools for scanning. | |
| - name: Initialize CodeQL | |
| uses: github/codeql-action/init@v4 | |
| with: | |
| languages: ${{ matrix.language }} | |
| build-mode: ${{ matrix.build-mode }} | |
| # If you wish to specify custom queries, you can do so here or in a config file. | |
| # By default, queries listed here will override any specified in a config file. | |
| # Prefix the list here with "+" to use these queries and those in the config file. | |
| # For more details on CodeQL's query packs, refer to: https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs | |
| # queries: security-extended,security-and-quality | |
| # If the analyze step fails for one of the languages you are analyzing with | |
| # "We were unable to automatically build your code", modify the matrix above | |
| # to set the build mode to "manual" for that language. Then modify this step | |
| # to build your code. | |
| # ℹ️ Command-line programs to run using the OS shell. | |
| # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun | |
| - name: Run manual build steps (Android) | |
| if: matrix.build-mode == 'manual' && matrix.language == 'java-kotlin' | |
| run: | | |
| set -e | |
| echo "Setting up JDK (Temurin 17)..." | |
| echo "Building project with Gradle wrapper (Debug build)..." | |
| chmod +x ./gradlew || true | |
| export ANDROID_SDK_ROOT=$HOME/android-sdk | |
| export ANDROID_HOME=$ANDROID_SDK_ROOT | |
| export PATH=$ANDROID_SDK_ROOT/cmdline-tools/latest/bin:$ANDROID_SDK_ROOT/platform-tools:$PATH | |
| # Ensure Gradle uses the runner's JAVA_HOME (overrides any repo gradle.properties value) | |
| # Using assembleDebug instead of assemble (Release build has compilation errors) | |
| ./gradlew -Dorg.gradle.java.home="$JAVA_HOME" assembleDebug --no-daemon --stacktrace || (echo "Gradle build failed" && exit 1) | |
| - name: Run manual build steps (non-Android Java) | |
| if: matrix.build-mode == 'manual' && matrix.language != 'java-kotlin' | |
| shell: bash | |
| run: | | |
| echo 'Add custom build steps for this language here, for example:' | |
| echo ' ./gradlew build' | |
| exit 1 | |
| # Alternative: explicitly set up JDK and Android SDK with actions for more reliable results | |
| # Example (uncomment and adapt if available): | |
| # - name: Set up Java | |
| # uses: actions/setup-java@v4 | |
| # with: | |
| # distribution: 'temurin' | |
| # java-version: '17' | |
| # - name: Set up Android SDK | |
| # uses: android-actions/setup-android@v2 | |
| # with: | |
| # api-level: 33 | |
| # build-tools: '33.0.2' | |
| - name: Perform CodeQL Analysis | |
| uses: github/codeql-action/analyze@v4 | |
| with: | |
| category: "/language:${{matrix.language}}" |