Skip to content

Enable CodeQL with codeql-analysis.yml #1464

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 28, 2021
Merged

Conversation

andyleejordan
Copy link
Member

@andyleejordan andyleejordan commented Apr 28, 2021

Adds (almost) automatically setup CodeQL support to resolve #1463. Autobuild didn't work so I just called our Azure pipelines script, and that worked fine.

@andyleejordan andyleejordan added Issue-Enhancement A feature request (enhancement). Area-Build & Release labels Apr 28, 2021
@andyleejordan andyleejordan requested a review from rjmholt as a code owner April 28, 2021 21:37
@andyleejordan
Copy link
Member Author

@rjmholt The "1 analysis not found" is to be expected as CodeQL compares diffs, and there is no pre-existing scan for comparison. All future PRs should work properly, and we can then require that check.

@andyleejordan
Copy link
Member Author

@rjmholt I stepped through these instructions:

Screen Shot 2021-04-28 at 3 12 27 PM

Screen Shot 2021-04-28 at 3 13 10 PM

And then modified these defaults:

# 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"

on:
  push:
    branches: [ master, legacy/1.x ]
  pull_request:
    # The branches below must be a subset of the branches above
    branches: [ master ]
  schedule:
    - cron: '26 18 * * 1'

jobs:
  analyze:
    name: Analyze
    runs-on: ubuntu-latest
    permissions:
      actions: read
      contents: read
      security-events: write

    strategy:
      fail-fast: false
      matrix:
        language: [ 'csharp' ]
        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python' ]
        # Learn more:
        # https://docs.github.com/en/free-pro-team@latest/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning#changing-the-languages-that-are-analyzed

    steps:
    - name: Checkout repository
      uses: actions/checkout@v2

    # Initializes the CodeQL tools for scanning.
    - name: Initialize CodeQL
      uses: github/codeql-action/init@v1
      with:
        languages: ${{ matrix.language }}
        # 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.
        # queries: ./path/to/local/query, your-org/your-repo/queries@main

    # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
    # If this step fails, then you should remove it and run the build manually (see below)
    - name: Autobuild
      uses: github/codeql-action/autobuild@v1

    # ℹ️ Command-line programs to run using the OS shell.
    # 📚 https://git.io/JvXDl

    # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
    #    and modify them (or add more) to build your code if your project
    #    uses a compiled language

    #- run: |
    #   make bootstrap
    #   make release

    - name: Perform CodeQL Analysis
      uses: github/codeql-action/analyze@v1

@andyleejordan
Copy link
Member Author

@andyleejordan andyleejordan merged commit ffc9c18 into master Apr 28, 2021
@andyleejordan andyleejordan deleted the andschwa/codeql branch April 28, 2021 22:37
@andyleejordan andyleejordan changed the title Create codeql-analysis.yml Enable CodeQL with codeql-analysis.yml May 21, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Area-Build & Release Issue-Enhancement A feature request (enhancement).
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Enable CodeQL
2 participants