Skip to main content

Выполнение проверки кода CodeQL в контейнере

Вы можете запускаться code scanning в контейнере, обеспечив выполнение всех процессов в одном контейнере.

Кто может использовать эту функцию?

Code scanning доступен для следующих типов репозитория:

  • Общедоступные репозитории для GitHub.com
  • Репозитории, принадлежащие организации, на GitHub Team, GitHub Enterprise Cloud или GitHub Enterprise Server, с включённым GitHub Code Security .

О code scanning фильме с контейнерной сборкой

Если вы настраиваете code scanning для скомпилированного языка и создаёте код в контейнерной среде, анализ может провалиться с сообщением об ошибке «Исходный код не виден во время сборки». Это указывает на то, что CodeQL не удалось отслеживать ваш код во время компиляции.

Вы должны запускаться CodeQL внутри контейнера, в котором строите свой код. Это относится независимо от того, используете ли вы или CodeQL CLIGitHub Actions. Для CodeQL CLI, см. Использование сканирования кода с существующей системой CI для дополнительной информации. Если вы используете GitHub Actions, настройте рабочий процесс так, чтобы все действия выполнялись в одном контейнере. Дополнительные сведения см. в разделе "Пример рабочего процесса".

Примечание.

В настоящее время CodeQL CLI несовместим с дистрибутивами Linux не на основе glibc, такими как Alpine Linux (на основе musl).

Зависимости для CodeQLcode scanning

Может возникнуть трудности с запуском code scanning , если используемый вами контейнер отсутствует определённые зависимости (например, Git нужно установить и добавить в переменную PATH). Если вы столкнулись с проблемами зависимости, ознакомьтесь с программным обеспечением, которое обычно присутствует на GitHubизображениях runner's. Дополнительные сведения см. в файлах readme для соответствующих версий в следующих местах:

Пример рабочего процесса

Примечание.

В этой статье описываются функции, доступные в версии действия CodeQL и связанного пакета CodeQL CLI в первоначальном выпуске этой версии GitHub Enterprise Server. Если ваше предприятие использует более последнюю версию действия CodeQL, ознакомьтесь с версией GitHub Enterprise Cloud этой статьи, чтобы узнать о последних функциях. Сведения об использовании последней версии см. в разделе Настройка сканирования кода для вашего устройства.

Этот примерный рабочий процесс используется GitHub Actions для анализа CodeQL в контейнерной среде. Значение container.image идентифицирует используемый контейнер. В этом примере изображение называется codeql-container и снабжено тегом f0f91db. Дополнительные сведения см. в разделе Синтаксис рабочего процесса для GitHub Actions.

name: "CodeQL"

on:
  push:
    branches: [main]
  pull_request:
    branches: [main]
  schedule:
    - cron: '15 5 * * 3'

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

    strategy:
      fail-fast: false
      matrix:
        language: [java-kotlin]

    # Specify the container in which actions will run
    container:
      image: codeql-container:f0f91db

    steps:
      - name: Checkout repository
        uses: actions/checkout@v6
      - name: Initialize CodeQL
        uses: github/codeql-action/init@v4
        with:
          languages: ${{ matrix.language }}
      - name: Build
        run: |
          ./configure
          make
      - name: Perform CodeQL Analysis
        uses: github/codeql-action/analyze@v4