codeql-analysis.yml

name: "CodeQL Analysis"

# This workflow runs:
# 1. On every push to master
# 2. On every PR to master which modifies this file (the configuration)
# 3. Every 6 hours every day.
#
# It is restrictive and run sparingly because it takes over an hour to run a full static analysis using this tool
# and we can't realistically run it on every PR.

on:
  push:
    branches: [master] # Triggers on every actual push to master
  pull_request:
    branches: [master]
    paths:
      - ".github/workflows/codeql-analysis.yml" # Only triggers on PRs that modify the configuration

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

    strategy:
      fail-fast: false
      matrix:
        config:
          - name: Ubuntu_20.04
            os: ubuntu-latest
            arch: x86_64 # as reported by `arch` or `uname -m`
            compiler_cache: ccache
            compiler_cache_path: ~/.ccache
            language: "cpp" # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python' ]
            vcpkg_binary_cache: ~/.cache/vcpkg
            vcpkg_triplet: x64-linux
            wxwidgets_git_url: https://github.com/wxWidgets/wxWidgets.git
            wxwidgets_git_ref: v3.1.5
            WX_CONFIG: /home/runner/work/tenacity/tenacity/wxwidgets-install/bin/wx-config

    steps:
      # Setup 64-bit GCC 11
      - name: Set up GCC
        uses: egor-tensin/setup-gcc@v1
        with:
          platform: x64
          version: 11

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

      - name: "[Linux] Install dependencies"
        if: runner.os == 'Linux'
        run: >-
          sudo apt-get update &&
          sudo apt-get install -y --no-install-recommends
          file
          g++
          ninja-build
          nasm
          git
          wget
          bash
          scdoc
          ccache
          debhelper-compat
          gettext
          libasound2-dev
          libgtk-3-dev
          libsuil-dev
          gettext

      - name: Get Git commit of vcpkg submodule
        run: echo VCPKG_COMMIT=$(git ls-tree HEAD vcpkg | awk '{print $3}') >> ${GITHUB_ENV}

      # FIXME: use wxWidgets from vcpkg for all OSes when bugs are fixed for Linux and macOS
      # https://github.com/microsoft/vcpkg/pull/17111
      - name: Build and install wxWidgets
        if: steps.wxwidgets-cache.outputs.cache-hit != 'true' && runner.os != 'Windows'
        run: |
          # wxWidgets' build system does not find dependencies from vcpkg, so use its vendored Git submodules
          wget https://github.com/wxWidgets/wxWidgets/releases/download/v3.1.5/wxWidgets-3.1.5.tar.bz2
          tar xvf wxWidgets-3.1.5.tar.bz2
          rm wxWidgets-3.1.5.tar.bz2
          cd wxWidgets-3.1.5
          cmake -G Ninja -D CMAKE_INSTALL_PREFIX=${{ github.workspace }}/wxwidgets-install \
            -S . -B cmake_build
          cmake --build cmake_build
          cmake --install cmake_build

      - name: Configure
        run: >-
          cmake
          -G Ninja
          -D CMAKE_BUILD_TYPE=${{ env.CMAKE_BUILD_TYPE }}
          -D CMAKE_INSTALL_PREFIX=${{ github.workspace }}/build/install
          -D VCPKG=ON
          -S .
          -B build
        env:
          CC: ${{ matrix.config.cc }}
          CXX: ${{ matrix.config.cxx }}
          # hack to get CMake to find wxWidgets until vcpkg wxWidgets port is fixed
          # https://github.com/microsoft/vcpkg/pull/17111
          WX_CONFIG: ${{ matrix.config.WX_CONFIG }}

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

      - name: Build
        run: cmake --build build --config ${{ env.CMAKE_BUILD_TYPE }} --verbose

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