Setting up code scanning for a repository

Options for setting up 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 "About code scanning."

Tipo de análisis	Opciones para generar alertas
CodeQL	Uso de GitHub Actions (vea "Configuración de code scanning mediante acciones") o ejecución del análisis de CodeQL en un sistema de integración continua (CI) de terceros (vea "Acerca de CodeQL code scanning en el sistema de CI").
Third‑party	Uso de GitHub Actions (vea "Configuración de code scanning mediante acciones") o generado de forma externa y cargado a GitHub Enterprise Cloud (vea "Carga de un archivo SARIF a GitHub").

Si ejecuta el análisis de código mediante varias configuraciones, en ocasiones una alerta tendrá varios orígenes de análisis. Si una alerta tiene varios orígenes de análisis, puede ver el estado de la alerta para cada origen de análisis en la página de alertas. Para más información, vea "Acerca de los orígenes de análisis".

Setting up code scanning using starter workflows

GitHub Enterprise Cloud proporciona flujos de trabajo de inicio para características de seguridad como code scanning. Puedes utilizar estos flujos de trabajo sugeridos para construir tus flujos de trabajo del code scanning en vez de comenzar desde cero. Code scanning starter workflows are only available for your repository if code scanning is enabled.

Al usar acciones para ejecutar code scanning se usarán minutos. Para más información, vea "Acerca de la facturación de GitHub Actions".

1. On GitHub.com, navigate to the main page of the repository.
2. En el nombre del repositorio, haga clic en Acciones.
3. If the repository has already at least one workflow set up and running, click New workflow and go to step 5. If there are currently no workflows configured for the repository, go to the next step.
4. Scroll down to the "Security" category and click Configure under the workflow you want to configure, or click View all to see all available security workflows.
5. On the right pane of the workflow page, click Documentation and follow the on-screen instructions to tailor the workflow to your needs. For more information, see "Using starter workflows" and "Configuring code scanning."

Setting up code scanning manually

Al usar acciones para ejecutar code scanning se usarán minutos. Para más información, vea "Acerca de la facturación de GitHub Actions".

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

2. En el nombre del repositorio, haz clic en Seguridad.

3. To the right of "Code scanning alerts", click Set up code scanning. If code scanning is missing, you need to ask an organization owner or repository administrator to enable GitHub Advanced Security. For more information, see "Managing security and analysis settings for your organization" or "Managing security and analysis settings for your repository."

4. Under "Get started with code scanning", click Set up this workflow on the CodeQL analysis workflow or on a third-party workflow. Workflows are only displayed if they are relevant for the programming languages detected in the repository. The CodeQL analysis workflow is always displayed, but the "Set up this workflow" button is only enabled if CodeQL analysis supports the languages present in the repository.

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 "Configuring 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 default 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 "Scanning pull requests" and "Scanning on push."

Bulk set up of code scanning

You can set up code scanning in many repositories at once using a script. If you'd like to use a script to raise pull requests that add a GitHub Actions workflow to multiple repositories, see the jhutchings1/Create-ActionsPRs repository for an example using PowerShell, or nickliffen/ghas-enablement for teams who do not have PowerShell and instead would like to use NodeJS.

Viewing the logging output from code scanning

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

1. En el nombre del repositorio, haga clic en Acciones.

   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 setting up 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 set up code scanning. For more information, see "Triaging code scanning alerts in pull requests."
• Set up 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 setup of CodeQL code scanning. For more information, see "Troubleshooting the CodeQL workflow."
• Customize how code scanning scans the code in your repository. For more information, see "Configuring code scanning."