Configuring advanced setup for code scanning

If you do not need a highly customizable code scanning configuration, consider using default setup for code scanning. For more information, see コード スキャンのセットアップの種類について.

Prerequisites

Your repository is eligible for advanced setup if it meets these requirements.

• It uses CodeQL-supported languages or you plan to generate code scanning results with a third-party tool.
• GitHub Actions が有効になっています。
• GitHub Code Security が有効になっている。

If the server on which you are running GitHub Enterprise Server is not connected to the internet, your site administrator can enable CodeQL code scanning by making the CodeQL analysis bundle available on the server. For more information, see アプライアンス用コードスキャンの構成.

Configuring advanced setup for code scanning with CodeQL

You can customize your CodeQL analysis by creating and editing a workflow file. Selecting advanced setup generates a basic workflow file for you to customize using standard workflow syntax and specifying options for the CodeQL action. See ワークフロー and コード スキャンのワークフロー構成オプション.

1. GitHub で、リポジトリのメイン ページに移動します。

2. リポジトリ名の下にある [Settings] をクリックします。 [設定] タブが表示されない場合は、 [] ドロップダウン メニューを選び、 [設定] をクリックします。

   

3. サイドバーの [Security] セクションで、[ Advanced Security] をクリックします。

4. Scroll down to "Code Security", in the "CodeQL analysis" row select Set up , then click Advanced.

   メモ

   If you are switching from default setup to advanced setup, in the "CodeQL analysis" row, 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 分析ワークフロー 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 コード スキャンのワークフロー構成オプション and CodeQL code scanning for compiled languages.

6. Click Commit changes... to display the commit changes form.

   

7. In the commit message field, type a commit message.

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

9. Click Commit new file to commit the workflow file to the default branch or click Propose new file to commit the file to a new branch.

10. If you created a new branch, click Create pull request and open a pull request to merge your change into the default branch.

In the suggested CodeQL 分析ワークフロー, 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. See コード スキャンのワークフロー構成オプション and ワークフローをトリガーする.

For information on bulk enablement, see CodeQL で大規模にコード スキャンの高度なセットアップを構成する.

Next steps

After your workflow runs successfully at least once, you are ready to start examining and resolving code scanning alerts. For more information on code scanning alerts, see Code scanningアラートについて and リポジトリのコード スキャンのアラートの評価.

Learn how code scanning runs behave as checks on pull requests, see Pull RequestでCode scanningアラートをトリアージする.

You can find detailed information about your code scanning configuration, including timestamps for each scan and the percentage of files scanned, on the tool status page. For more information, see Use the tool status page for code scanning.

Further reading

• Pull RequestでCode scanningアラートをトリアージする.
• 通知を設定する.
• コード スキャンのワークフロー構成オプション.
• GitHub Actionsからのコード スキャン ログの表示.