Note: Code scanning is currently in beta and subject to change. To request access to the beta, join the waitlist.
- On GitHub, navigate to the main page of the repository.
- Under your repository name, click Security.
- To the right of "Code scanning", click Set up code scanning.
- Under "Get started with code scanning", click Set up this workflow.
- Optionally, to customize how code scanning scans your code, edit the workflow. For more information, see "Configuring code scanning."
- Use the Start commit drop-down, and type a commit message.
- Choose whether you'd like to commit directly to the default branch, or create a new branch and start a pull request.
- Click Commit new file or Propose new file.
After you commit the workflow file or create a pull request, code scanning will analyze your code according to the frequency you specified in your workflow file. If you created a pull request, code scanning will only analyze the code on the pull request's topic branch until you merge the pull request into the default branch of the repository.
After you enable code scanning, you can monitor analysis, view results, and further customize how you scan your code.
- You can view the run status of code scanning and get notifications for completed runs. For more information, see "Managing a workflow run" and "Configuring notifications."
- After a scan completes, you can view alerts from a completed scan. For more information, see "Managing alerts from code scanning."
- You can customize how code scanning scans the code in your repository. For more information, see "Configuring code scanning."