Skip to content
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
111 changes: 111 additions & 0 deletions .github/workflows/codeql.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,111 @@
# 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: [ "master" ]
pull_request:
branches: [ "master" ]
schedule:
- cron: '15 13 * * 1'

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: javascript-typescript
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
Copy link

Copilot AI Nov 22, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The checkout action version is inconsistent with other workflows in the project. The test.yaml and android-release.yaml workflows both use actions/checkout@v5, while this workflow uses actions/checkout@v4. For consistency and to use the latest version, this should be updated to @v5.

Suggested change
uses: actions/checkout@v4
uses: actions/checkout@v5

Copilot uses AI. Check for mistakes.

# 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: Setup runtime (example)
# uses: actions/setup-example@v1

Copy link

Copilot AI Nov 22, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Missing required Java and Android SDK setup steps for the manual build. Other workflows in the project (test.yaml and android-release.yaml) show that both JDK 21 (Temurin distribution) and Android SDK setup are necessary before building Android projects. These setup steps should be added before line 70 (Initialize CodeQL) for the java-kotlin language matrix entry.

Example from test.yaml:

- name: 📦 Setup JDK
  uses: actions/setup-java@v5
  with:
    distribution: "temurin"
    java-version: "21"
    cache: "gradle"

- name: 📦 Setup Android SDK
  uses: android-actions/setup-android@v3
Suggested change
- name: 📦 Setup JDK
if: matrix.language == 'java-kotlin'
uses: actions/setup-java@v5
with:
distribution: "temurin"
java-version: "21"
cache: "gradle"
- name: 📦 Setup Android SDK
if: matrix.language == 'java-kotlin'
uses: android-actions/setup-android@v3

Copilot uses AI. Check for mistakes.
# 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

# Setup keystore
- name: 🔐 Setup Keystore
if: matrix.language == 'java-kotlin'
env:
KEYSTORE_BASE64: ${{ secrets.KEYSTORE_BASE64 }}
run: |
echo $KEYSTORE_BASE64 | base64 --decode > keystore.jks
Copy link

Copilot AI Nov 22, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The keystore setup step will fail if the KEYSTORE_BASE64 secret is not set or is empty. The echo command should be quoted to properly handle the secret value, and the workflow should check if the secret exists before attempting to decode it. Consider adding a check or ensuring the secret is always available.

Suggested fix:

run: |
  echo "$KEYSTORE_BASE64" | base64 --decode > keystore.jks
Suggested change
echo $KEYSTORE_BASE64 | base64 --decode > keystore.jks
if [ -z "$KEYSTORE_BASE64" ]; then
echo "ERROR: KEYSTORE_BASE64 secret is not set or is empty." >&2
exit 1
fi
echo "$KEYSTORE_BASE64" | base64 --decode > keystore.jks

Copilot uses AI. Check for mistakes.


# 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
if: matrix.build-mode == 'manual' && matrix.language == 'java-kotlin'
Copy link

Copilot AI Nov 22, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The conditional logic matrix.build-mode == 'manual' && matrix.language == 'java-kotlin' is redundant. Based on the matrix configuration (lines 45-51), only java-kotlin has build-mode: manual, so checking both conditions is unnecessary. The condition can be simplified to just matrix.build-mode == 'manual'.

Suggested change
if: matrix.build-mode == 'manual' && matrix.language == 'java-kotlin'
if: matrix.build-mode == 'manual'

Copilot uses AI. Check for mistakes.
shell: bash
env:
KEYSTORE_PASSWORD: ${{ secrets.KEYSTORE_PASSWORD }}
KEY_ALIAS: ${{ secrets.KEY_ALIAS }}
KEY_PASSWORD: ${{ secrets.KEY_PASSWORD }}
run: |
./scripts/build-apk.sh
Comment on lines +105 to +106
Copy link

Copilot AI Nov 22, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[nitpick] The gradlew script needs to be made executable before running the build. While scripts/build-apk.sh includes chmod +x ./gradlew, it's better practice to ensure the permissions are set before calling any Gradle commands. Consider adding this step before running the build script or ensuring it's committed with executable permissions.

Copilot uses AI. Check for mistakes.

- name: Perform CodeQL Analysis
uses: github/codeql-action/analyze@v4
with:
category: "/language:${{matrix.language}}"