Skip to main content

Журналы недостаточно подробные

Увеличивайте многословность логов и генерируйте отладочные артефакты, когда логи не хватают диагностических деталей.

Если ваши журналы недостаточно подробны для устранения проблемы, существует несколько шагов, чтобы получить дополнительную информацию и сделать логи более полезными.

Включение ведения журнала отладки шагов

Логирование отладки шагов увеличивает объяснение логов задания во время и после выполнения.

Для включения поэтапного отладочного логирования:

  1. В репозитории, содержащем рабочий процесс, установите следующий секрет или переменную: в . Если заданы секрет и переменная, значение секрета имеет приоритет над переменной.
  2. Запусти рабочий процесс заново или запусти новый запуск.

После задания секрета или переменной в журналах шагов отображаются дополнительные события отладки. См . раздел AUTOTITLE.

Вы также можете использовать контекст для условного запуска шагов только при включении отладочных логировок. См . раздел AUTOTITLE.

Создание артефактов отладки данных CodeQL

Предупреждение

Артефакты отладки CodeQL содержат копию исходного кода, анализируемую CodeQL, поэтому мы рекомендуем совместно использовать эти пакеты только пользователям, которым разрешен доступ к этому исходному коду.

Вы можете получить артефакты, которые помогут отлаживать CodeQL. Отладочные артефакты будут загружаны в рабочий процесс в виде артефактов с именами, начинающимися на . Если CodeQL анализирует несколько языков одновременно в рамках рабочего процесса, для каждого языка будет один такой артефакт. Данные содержат журналы CodeQL, базы данных CodeQL, извлечённые файлы исходного кода и любые SARIF-файлы, созданные в результате рабочего процесса. Дополнительные сведения о скачивании артефактов CodeQL см. в разделе AUTOTITLE.

Эти артефакты помогут вам устранять проблемы с CodeQL code scanning. Если вы свяжетесь с Служба поддержки GitHub, они могут запросить эти данные.

Создание CodeQL отладка артефактов для CodeQL настройка по умолчанию

Вы можете создать CodeQL отладочные артефакты, включив логирование отладки шагов (см. Включение пошагового отладочного логирования) и запустив новый анализ CodeQL, например, отправив новый коммит в ветку pull request.

Если вы предоставили CodeQL доступ к частным реестрам, будут доступны дополнительные артефакты с начинающимися именами . Они содержат логи прокси аутентификации, используемого по умолчанию CodeQL для аутентификации запросов в приватные реестры и могут использоваться для устранения неполадок в конфигурациях приватного реестра. Дополнительные сведения см. в разделе AUTOTITLE.

Creating CodeQL debugging artifacts for CodeQL advanced setup

Отладочные артефакты для CodeQL расширенной настройки можно получить несколькими способами.

Повторный запуск заданий с включённым логированием отладки

Самый простой способ создания отладочных артефактов для расширенной настройки CodeQL — это повторный запуск заданий с включённым логированием отладки. Дополнительные сведения о повторном выполнении рабочих процессов и заданий GitHub Actions см. в разделе AUTOTITLE.

Необходимо выбрать параметр Включить ведение журнала отладки. Он позволит включить ведение журнала диагностики средства выполнения и ведение журнала отладки шага для выполнения. Затем вы сможете скачать CodeQL отладочные артефакты для дальнейшего изучения. Изменять файл рабочего процесса при создании артефактов отладки CodeQL путем повторного выполнения заданий не требуется.

Использование флага рабочего процесса

Вы можете создать артефакты отладки CodeQL с помощью флага в рабочем процессе. Для этого необходимо изменить шаг файла Рабочий процесс анализа CodeQL и задать .

- name: Initialize CodeQL
  uses: github/codeql-action/init@v4
  with:
    debug: true

Использование GitHub Actions step debug log

Если вы включите GitHub Actions шаговое логирование отладки, CodeQL также создаст отладочные артефакты и загрузит их в рамках запуска рабочего процесса. Инструкции смотрите в разделе «Включение этапного отладочного логирования».