Skip to main content

Enabling GitHub Code Quality

Use Code Quality to automatically catch, fix, and report on code quality issues in pull requests and on your default branch.

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

Repository owners, organization owners, security managers, and users with the admin role

GitHub Code Quality is available for:

  • Public repositories on GitHub.com
  • Organization-owned repositories on GitHub Team or GitHub Enterprise Cloud

Примечание.

GitHub Code Quality is currently in public preview and subject to change. During public preview, Code Quality will not be billed, although Code Quality scans will consume GitHub Actions minutes.

Prerequisites

  • GitHub Actions must be enabled because Code Quality uses actions to run each CodeQL analysis.
  • To get the full benefit of the feature, your repository should include one of the languages supported for quality analysis by CodeQL. See Supported languages.

Enabling Code Quality for a repository

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

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

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

  3. In the sidebar, under "Security", click Code quality to display the "Code quality" page.

  4. Click Enable code quality.

    Примечание.

    If Enable code quality is missing from this view, your enterprise owner has disabled the use of Code Security and Code Quality for your organization. See Allowing use of GitHub Code Quality in your enterprise.

  5. Review the information on the Code quality page:

  6. Click Save changes to save your configuration for Code Quality.

Совет

If your organization has configured caching of private registries, these will be available for code quality analysis to use to resolve dependencies. See Предоставление доступа к частным реестрам функций безопасности.

Next steps