Необходимые условия
Чтобы свойства репозитория, описанные здесь, имели эффект, необходимо настроить code scanning. См . раздел AUTOTITLE.
Свойства репозитория, которые влияют на code scanning них, должны быть созданы вручную для вашей организации. Затем вы можете задать значения, применимые ко всей вашей организации, или позволить их настраивать по-разному для каждого репозитория. См . раздел AUTOTITLE.
Тестирование изменений перед применением
Вы можете проверить, что конфигурации, применяемые с помощью свойств репозитория, имеют необходимые эффекты, прежде чем развертывать их во всей организации. Свойства репозитория можно задать для определенных значений для отдельных репозиториев. Если вы впервые настраиваете свойство репозитория, создайте его для организации, но не задали его значение. Вместо этого задайте для него значение для определенного тестового репозитория, где сначала можно проверить изменение. После проверки в тестовом репозитории можно задать значение для всей организации или нужных репозиториев.
При изменении значения поддерживаемого свойства репозитория можно использовать тот же подход. Переопределите или задайте значение свойства репозитория для тестового репозитория, проверьте изменение, а затем разверните его в организации или других репозиториях.
Поддерживаемые свойства репозитория для code scanning
Некоторые code scanning функции можно настроить с помощью свойств репозитория. Организации могут использовать свойства репозиториев для обеспечения конфигураций как во всех репозиториях, так и для отдельных репозиториев. При code scanning настройке с помощью свойств репозитория настройка применяется ко всем типам установки.
Ниже приведен обзор свойств репозитория, которые влияют на code scanning анализ при настройке:
| Имя | Тип |
|---|---|
github-codeql-config-file | Текст |
github-codeql-extra-queries | Текст |
github-codeql-disable-overlay | True/false |
github-codeql-file-coverage-on-prs | True/false |
github-codeql-tools | Текст |
Примечание.
Свойства репозитория, которые поддерживаются, зависят от версии github/codeql-action , используемой анализом code scanning . Для code scanning расширенной настройки убедитесь, что рабочий процесс ссылается на последнюю основную версию. Code scanning Программа установки по умолчанию автоматически использует последнюю версию.
Пользовательские конфигурационные файлы
Для свойства можно задать github-codeql-config-file локальный или удаленный путь к файлу конфигурации. Допустимые значения для этого свойства совпадают с config-file параметром codeql-action/init действия. Дополнительные сведения о допустимых форматах пути и возможном содержимом файлов конфигурации см. в разделе Параметры настройки рабочих процессов для сканирования кода.
Значение, указанное для свойства, будет применяться как к настройке github-codeql-config-file по умолчанию, так code scanning и code scanning к расширенной настройке. Если рабочий процесс расширенной codeql-action/init установки указывает явные входные данные для config-file параметра действия, то входные данные будут иметь приоритет над значением, настроенным в свойстве репозитория. Это позволяет расширенным рабочим процессам использовать разные конфигурации, отличные от тех, которые применяются к рабочим процессам установки по умолчанию при необходимости.
Настраиваемый файл конфигурации, примененный с помощью github-codeql-config-file свойства, объединяется с конфигурацией, которая code scanning по умолчанию создается автоматически.
Code scanning Настройка по умолчанию позволяет настроить некоторые параметры анализа в пользовательском интерфейсе, например, какие модели угроз или CodeQL пакеты моделей следует использовать. Эти выборы хранятся в объединенной конфигурации: модели угроз, выбранные в пользовательском интерфейсе установки по умолчанию, объединяются с любыми моделями угроз, указанными в файле конфигурации, и пакеты моделей, настроенные в пользовательском интерфейсе, хранятся.Дополнительные сведения о доступных параметрах конфигурации по умолчанию см. в code scanningautoTITLE.
Другая настройка анализа
Это github-codeql-extra-queries свойство позволяет настраивать дополнительные запросы, которые должны выполняться. Это полезно для добавления запросов ко всем релевантным анализам в вашей организации без необходимости изменять отдельные рабочие процессы или переключаться на продвинутую конфигурацию. Он принимает те же значения, что и queries вход github/codeql-action. См . раздел AUTOTITLE.
По умолчанию анализы используют последнюю выпущенную версию code scanning CodeQL. Это обычно не рекомендуется изменять, если вы не работаете с определенной проблемой, которая устранена путем переключения на другую версию. Если это необходимо изменить, github-codeql-tools свойство позволяет указать другую версию.
Если рабочий процесс расширенной codeql-action/init установки указывает явные входные данные для tools параметра действия, то входные данные будут иметь приоритет над значением, настроенным в свойстве репозитория. Это позволяет расширенным рабочим процессам использовать разные конфигурации, отличные от тех, которые применяются к рабочим процессам установки по умолчанию при необходимости. Чтобы применить значение свойства репозитория для расширенных рабочих процессов установки, даже если они имеют явные tools входные данные, добавьте ! префикс в значение свойства репозитория. Например, !nightly принудительно применяется, чтобы все рабочие процессы использовали последнюю nightly версию.
Включение или отключение функций
Вы можете отключить улучшенный инкрементальный анализ, установив github-codeql-disable-overlay свойство на true. Это может быть полезно, если улучшенный инкрементальный анализ не работает из-за возросших аппаратных требований.
Информация о покрытии файлов не рассчитывается для анализа pull request. Если вы хотите включить информацию о покрытии файлов для pull request, можно установить github-codeql-file-coverage-on-prs свойство на true.