Skip to main content

Включение GitHub Code Quality

Code Quality Включите, чтобы предоставить командам согласованный базовый план качества: автоматическое перехват, исправление и создание отчетов о проблемах качества кода в запросах на вытягивание и в ветви по умолчанию.

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

Владельцы репозиториев, владельцы организаций и пользователи с административной ролью

GitHub Team или GitHub Enterprise Cloud

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

Предпосылки

  • Владелец бизнеса должен иметь разрешение Code Quality на ваше предприятие. См . раздел AUTOTITLE.
  • GitHub Actions должно быть включено, потому что Code Quality использует действия для запуска каждого CodeQL анализа.
  • Чтобы получить полную пользу от этой функции, ваш репозиторий должен включать один из языков, поддерживаемых для качественного анализа .CodeQL Смотрите раздел Поддерживаемые языки.

Включение Code Quality вашего репозитория

  1. На GitHubперейдите на главную страницу репозитория.

  2. Под именем репозитория щелкните Settings. Если вкладка "Параметры" не отображается, выберите раскрывающееся меню и нажмите кнопку "Параметры".

    Снимок экрана: заголовок репозитория с вкладками. Вкладка "Параметры" выделена темно-оранжевым контуром.

  3. В боковой панели, в разделе «Безопасность», нажмите Качество кода для открытия страницы «Качество кода».

  4. Нажмите Включить качество кода.

  5. Ознакомьтесь с информацией на странице Качество кода:

    • Языки: Если хотите отключить CodeQL анализ для любого из языков, уберите соответствующую галочку.
    • Тип бегуна: Если вы хотите использовать другое средство выполнения, выберите Помеченное средство выполнения и определите метку Средство выполнения. См. раздел [AUTOTITLE и Использование средств выполнения, размещенных в GitHub](/actions/how-tos/manage-runners/self-hosted-runners/apply-labels).
  6. Нажмите «Сохранить изменения », чтобы сохранить конфигурацию для Code Quality.

Если в организации настроено кэширование частных реестров, они будут доступны для анализа качества кода для разрешения зависимостей. См . раздел AUTOTITLE.

Поддержка Code Quality для вашей организации

На уровне организации вы управляете Code Quality одним параметром доступа к репозиторию . Это дает детализированные параметры, начиная от включения каждого репозитория в целевой список или динамический фильтр, чтобы вы могли пилотировать Code Quality намеренно и развертывать его в собственном темпе. Репозитории в выделенном фрагменте включены, а репозитории за пределами выделенного фрагмента отключены.

Доступные параметры доступа и способы фильтрации и применения см. в разделе Включение качества кода в организациях и организациях.

  1. На GitHubперейдите на главную страницу организации.

  2. Под именем организации щелкните Settings. Если вкладка "Параметры" не отображается, выберите раскрывающееся меню и нажмите кнопку "Параметры".

    Снимок экрана: вкладки в профиле организации. Вкладка "Параметры" выделена темно-оранжевым цветом.

  3. В боковой панели, в разделе «Безопасность», нажмите Качество кода.

  4. В разделе "Доступ к репозиторию" выберите параметр в раскрывающемся меню.

    • Если выбраны выбранные репозитории..., выберите репозитории, которые вы хотите включить.
    • Если выбрано сопоставление фильтра..., определите фильтр.
  5. При необходимости, чтобы запретить администраторам репозитория изменять эти параметры, включите принудительное доступ.

  6. Если изменение включает или отключает Code Quality любые репозитории, появится диалоговое окно "Просмотр изменений включения и выставления счетов", показывающее общее количество включенных и отключенных репозиториев и связанных затрат. Просмотрите сведения, а затем нажмите кнопку "Подтвердить".

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

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

Дальнейшие шаги

  • Добавление покрытия кода: Отправьте отчет о охвате кода из набора тестов, чтобы просмотреть результаты покрытия непосредственно на запросы на вытягивание. См . раздел AUTOTITLE.
  • Для вашей организации: Понимайте состояние кода ваших репозиториев с первого взгляда. См . раздел AUTOTITLE.