Skip to content

Commit

Permalink
Scan for security vulnerabilities with GitHub CodeQL
Browse files Browse the repository at this point in the history
Scan for security vulnerabilities with GitHub CodeQL by adding `codeql.yml` workflow.
  • Loading branch information
rgoldberg authored Nov 19, 2024
1 parent ca921c0 commit 235cc1f
Showing 1 changed file with 91 additions and 0 deletions.
91 changes: 91 additions & 0 deletions .github/workflows/codeql.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,91 @@
# 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"

Check warning on line 12 in .github/workflows/codeql.yml

View workflow job for this annotation

GitHub Actions / Build, Test, and Lint

12:1 [document-start] missing document start "---"

on:
push:
branches: [ "main", "v*" ]

Check failure on line 16 in .github/workflows/codeql.yml

View workflow job for this annotation

GitHub Actions / Build, Test, and Lint

16:16 [brackets] too many spaces inside brackets

Check failure on line 16 in .github/workflows/codeql.yml

View workflow job for this annotation

GitHub Actions / Build, Test, and Lint

16:29 [brackets] too many spaces inside brackets
pull_request:
branches: [ "main", "v*" ]

Check failure on line 18 in .github/workflows/codeql.yml

View workflow job for this annotation

GitHub Actions / Build, Test, and Lint

18:16 [brackets] too many spaces inside brackets

Check failure on line 18 in .github/workflows/codeql.yml

View workflow job for this annotation

GitHub Actions / Build, Test, and Lint

18:29 [brackets] too many spaces inside brackets
schedule:
- cron: '44 14 * * 4'

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: c-cpp

Check failure on line 46 in .github/workflows/codeql.yml

View workflow job for this annotation

GitHub Actions / Build, Test, and Lint

46:9 [indentation] wrong indentation: expected 10 but found 8
build-mode: manual
- language: ruby
build-mode: none
- language: swift
build-mode: manual
# CodeQL supports the following values keywords for 'language': 'c-cpp', 'csharp', 'go', 'java-kotlin', 'javascript-typescript', 'python', 'ruby', 'swift'

Check warning on line 52 in .github/workflows/codeql.yml

View workflow job for this annotation

GitHub Actions / Build, Test, and Lint

52:9 [comments-indentation] comment not indented like content

Check warning on line 52 in .github/workflows/codeql.yml

View workflow job for this annotation

GitHub Actions / Build, Test, and Lint

52:121 [line-length] line too long (162 > 120 characters)
# 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.

Check warning on line 57 in .github/workflows/codeql.yml

View workflow job for this annotation

GitHub Actions / Build, Test, and Lint

57:121 [line-length] line too long (164 > 120 characters)
# 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

Check warning on line 59 in .github/workflows/codeql.yml

View workflow job for this annotation

GitHub Actions / Build, Test, and Lint

59:121 [line-length] line too long (184 > 120 characters)
steps:
- name: Checkout repository

Check failure on line 61 in .github/workflows/codeql.yml

View workflow job for this annotation

GitHub Actions / Build, Test, and Lint

61:5 [indentation] wrong indentation: expected 6 but found 4
uses: actions/checkout@v4

# Initializes the CodeQL tools for scanning.
- name: Initialize CodeQL
uses: github/codeql-action/init@v3
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

Check warning on line 74 in .github/workflows/codeql.yml

View workflow job for this annotation

GitHub Actions / Build, Test, and Lint

74:121 [line-length] line too long (232 > 120 characters)
# 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
- if: matrix.build-mode == 'manual'
shell: bash
run: |
script/build
- name: Perform CodeQL Analysis
uses: github/codeql-action/analyze@v3
with:
category: "/language:${{matrix.language}}"

0 comments on commit 235cc1f

Please sign in to comment.