리포지토리에 대한 코드 검사 구성

Options for configuring code scanning

You decide how to generate code scanning alerts, and which tools to use, at a repository level. GitHub Enterprise Cloud provides fully integrated support for CodeQL analysis, and also supports analysis using third-party tools. For more information, see the following bullets and "About code scanning."

• CodeQL: Uses GitHub Actions with either the default setup (see "Configuring code scanning for a repository") or an advanced setup (see "Configuring code scanning for a repository"), or runs CodeQL analysis in a third-party continuous integration (CI) system (see "About CodeQL code scanning in your CI system").

• Third‑party: Uses GitHub Actions (see "Configuring code scanning for a repository") or third-party tools and uploads results to GitHub Enterprise Cloud (see "Uploading a SARIF file to GitHub").

If you run code scanning using multiple configurations, the same alert will sometimes be generated by more than one configuration. If an alert comes from multiple configurations, you can view the status of the alert for each configuration on the alert page. For more information, see "About code scanning alerts."

The tool status page shows useful information about all of your code scanning tools. If code scanning is not working as you'd expect, the tool status page is a good starting point for debugging problems. For more information, see "About the tool status page for code scanning".

Configuring code scanning automatically

The default setup for code scanning will automatically configure code scanning with the best settings for your repository. Default setup uses GitHub Actions to run CodeQL analysis without requiring you to commit a workflow file your repository.

Your repository is eligible for default setup if it uses GitHub Actions and contains only the following CodeQL-supported languages: JavaScript/TypeScript, Python, or Ruby. While you can use default setup if your repository includes languages that aren't supported by CodeQL, such as R, you must use the advanced setup if you include CodeQL-supported languages other than those previously listed. For more information on CodeQL-supported languages, see "About code scanning with CodeQL." For information on bulk enablement, see "Configuring code scanning at scale using CodeQL."

Enabling default setup is the quickest way to configure code scanning for your repository. Additionally, default setup requires none of the maintenance necessary with a CodeQL workflow file. Before you enable default setup, you'll see the languages it will analyze, the query suites it will run, and the events that will trigger a new scan.

Try default setup if you don't need to run extra queries, change the scan schedule, or scan a language that is currently unsupported by default setup.

1. On GitHub.com, navigate to the main page of the repository.

2. Under your repository name, click Settings. If you cannot see the "Settings" tab, select the dropdown menu, then click Settings.

   

3. In the "Security" section of the sidebar, click Code security and analysis.

4. In the "Code scanning" section, select Set up , then click Default.

   

5. In the CodeQL default configuration window that is displayed, review the settings for your repository, then click Enable CodeQL.

   Notes:

   • The CodeQL default configuration window displays the details of the default setup, including the languages to analyze, the query suites to run, and the events that trigger a new scan. If you would like to change which query suites will run, what events will trigger a new scan, or other code scanning features, you need to use the advanced setup. For more information, see "Configuring code scanning for a repository."
   • If you are switching to the default setup from the advanced setup, you will see a warning informing you that the default setup will override existing configurations. CodeQL default setup will disable the existing workflow file, and block any CodeQL analysis API uploads.
   • If you would like to see your default CodeQL setup after configuration, select , then click View CodeQL configuration.

Creating an advanced setup

The advanced setup for code scanning is helpful when you need to customize your code scanning. By creating and editing a workflow file, you can choose which queries to run, change the scan schedule, scan any CodeQL-supported language, use a matrix build, and more.

Configuring code scanning using starter workflows

GitHub Enterprise Cloud provides starter workflows for security features such as code scanning. You can use these suggested workflows to construct your code scanning workflows, instead of starting from scratch. Code scanning starter workflows are only available for your repository if code scanning is enabled.

Using actions to run code scanning will use minutes. For more information, see "About billing for GitHub Actions."

1. On GitHub.com, navigate to the main page of the repository.
2. Under your repository name, click Actions.
3. If the repository has already at least one workflow configured and running, click New workflow to display starter workflows. If there are currently no workflows configured for the repository, go to the next step.
4. In the "Choose a workflow" or "Get started with GitHub Actions" view, scroll down to the "Security" category and click Configure under the workflow you want to configure. You may need to click View all to find the security workflow you want to configure.
5. Follow any instructions in the workflow to customize it to your needs. For more general assistance about workflows, click Documentation on the right pane of the workflow page. For more information, see "Using starter workflows" and "Customizing code scanning."

Configuring code scanning manually

You can customize your code scanning by creating and editing a workflow file. The advanced setup generates a basic workflow file for you to customize.

Using actions to run code scanning will use minutes. For more information, see "About billing for GitHub Actions."

1. On GitHub.com, navigate to the main page of the repository.

2. Under your repository name, click Settings. If you cannot see the "Settings" tab, select the dropdown menu, then click Settings.

   

3. In the "Security" section of the sidebar, click Code security and analysis.

4. Scroll down to the "Code scanning" section, select Set up , then click Advanced.

   Note: If you are switching to the advanced code scanning setup from the default setup, in the "Code scanning" section, select , then click Switch to advanced. In the pop-up window that appears, click Disable CodeQL.

   

5. To customize how code scanning scans your code, edit the workflow.

   Generally, you can commit the CodeQL analysis workflow without making any changes to it. However, many of the third-party workflows require additional configuration, so read the comments in the workflow before committing.

   For more information, see "Customizing code scanning."

6. Use the Start commit drop-down, and type a commit message.

7. Choose whether you'd like to commit directly to the default branch, or create a new branch and start a pull request.

8. Click Commit new file or Propose new file.

In the suggested CodeQL analysis workflow, code scanning is configured to analyze your code each time you either push a change to the default branch or any protected branches, or raise a pull request against the default branch. As a result, code scanning will now commence.

The on:pull_request and on:push triggers for code scanning are each useful for different purposes. For more information, see "Customizing code scanning."

For information on bulk enablement, see "Configuring code scanning at scale using CodeQL."

Viewing the logging output from code scanning

After configuring code scanning for your repository, you can watch the output of the actions as they run.

1. Under your repository name, click Actions.

   You'll see a list that includes an entry for running the code scanning workflow. The text of the entry is the title you gave your commit message.

   

2. Click the entry for the code scanning workflow.

3. Click the job name on the left. For example, Analyze (LANGUAGE).

   

4. Review the logging output from the actions in this workflow as they run.

5. Once all jobs are complete, you can view the details of any code scanning alerts that were identified. For more information, see "Managing code scanning alerts for your repository."

Understanding the pull request checks

Each code scanning workflow you set to run on pull requests always has at least two entries listed in the checks section of a pull request. There is one entry for each of the analysis jobs in the workflow, and a final one for the results of the analysis.

The names of the code scanning analysis checks take the form: "TOOL NAME / JOB NAME (TRIGGER)." For example, for CodeQL, analysis of C++ code has the entry "CodeQL / Analyze (cpp) (pull_request)." You can click Details on a code scanning analysis entry to see logging data. This allows you to debug a problem if the analysis job failed. For example, for code scanning analysis of compiled languages, this can happen if the action can't build the code.

When the code scanning jobs complete, GitHub works out whether any alerts were added by the pull request and adds the "Code scanning results / TOOL NAME" entry to the list of checks. After code scanning has been performed at least once, you can click Details to view the results of the analysis.

Next steps

After configuring code scanning, and allowing its actions to complete, you can:

• View all of the code scanning alerts generated for this repository. For more information, see "Managing code scanning alerts for your repository."
• View any alerts generated for a pull request submitted after you configure code scanning. For more information, see "Triaging code scanning alerts in pull requests."
• Configure notifications for completed runs. For more information, see "Configuring notifications."
• View the logs generated by the code scanning analysis. For more information, see "Viewing code scanning logs."
• Investigate any problems that occur with the initial configuration of CodeQL code scanning. For more information, see "Troubleshooting your advanced setup for CodeQL."
• Customize how code scanning scans the code in your repository. For more information, see "Customizing code scanning."