Skip to content
Open
Show file tree
Hide file tree
Changes from 1 commit
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
2 changes: 2 additions & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
.github/workflows/*.yml linguist-detectable -linguist-vendored
.github/workflows/*.yaml linguist-detectable -linguist-vendored
147 changes: 147 additions & 0 deletions .github/workflows/codeql.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,147 @@
name: CodeQL Security Scan

on:
push:
branches: [main]
pull_request:
branches: [main]
schedule:
- cron: "20 2 * * 1" # weekly scan
workflow_dispatch:

jobs:

# --------------------------------------------------
# STEP 1: Detect languages automatically
# --------------------------------------------------

create-matrix:
runs-on: ubuntu-latest
if: ${{ github.repository_owner == 'AOSSIE-Org' }}

permissions:
security-events: write
actions: read
contents: read
packages: read

outputs:
matrix: ${{ steps.set-matrix.outputs.matrix }}

steps:

- name: Detect repository languages
id: set-matrix
uses: advanced-security/set-codeql-language-matrix@v1
with:
access-token: ${{ secrets.GITHUB_TOKEN }}
endpoint: ${{ github.event.repository.languages_url }}

# ⚠️ OPTIONAL
# exclude: 'java,python'

# ⚠️ OPTIONAL
# Force manual build for certain languages
# build-mode-manual-override: 'java'


# --------------------------------------------------
# STEP 2: Run CodeQL analysis
# --------------------------------------------------

analyze:
needs: create-matrix

if: ${{ github.repository_owner == 'AOSSIE-Org' && needs.create-matrix.outputs.matrix != '[]' }}

name: Analyze (${{ matrix.language }})

# Swift requires macOS runners
runs-on: ${{ matrix.language == 'swift' && 'macos-latest' || 'ubuntu-latest' }}

permissions:
security-events: write
actions: read
contents: read

strategy:
fail-fast: false
matrix: ${{ fromJSON(needs.create-matrix.outputs.matrix) }}

steps:

- name: Checkout repository
uses: actions/checkout@v4


# --------------------------------------------------
# LANGUAGE RUNTIME SETUPS
# Only run if language exists
# --------------------------------------------------

- name: Setup Node
if: matrix.language == 'javascript-typescript'
uses: actions/setup-node@v4
with:
node-version: 20 # ⚠️ MANUAL change if project requires another version


- name: Setup Python
if: matrix.language == 'python'
uses: actions/setup-python@v5
with:
python-version: '3.x' # ⚠️ MANUAL change if project pins version


- name: Setup Java
if: matrix.language == 'java-kotlin'
uses: actions/setup-java@v4
with:
distribution: temurin
java-version: '21' # ⚠️ MANUAL change if project uses 11 or 17



# --------------------------------------------------
# Initialize CodeQL
# IMPORTANT: must run BEFORE build
# --------------------------------------------------

- name: Initialize CodeQL
uses: github/codeql-action/init@v3
with:
languages: ${{ matrix.language }}
build-mode: ${{ matrix.build-mode }}

# ⚠️ OPTIONAL
# Uncomment for deeper scans
# queries: security-extended



# --------------------------------------------------
# MANUAL BUILD (only for compiled languages)
# CodeQL must observe the build process
# --------------------------------------------------

# Gradle build
- name: Build Java (Gradle)
if: matrix.language == 'java-kotlin' && matrix.build-mode == 'manual' && hashFiles('gradlew') != ''
run: ./gradlew build --no-daemon -x test


# Maven build
- name: Build Java (Maven)
if: matrix.language == 'java-kotlin' && matrix.build-mode == 'manual' && hashFiles('pom.xml') != ''
run: mvn -B package --file pom.xml



# --------------------------------------------------
# Run CodeQL scan
# --------------------------------------------------

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