Configuring code scanning for your appliance

You can enable, configure and disable escaneo de código for tu instancia de servidor de GitHub Enterprise. Escaneo de código allows users to scan code for vulnerabilities and errors.

Escaneo de código is available if you have a license for GitHub Advanced Security. For more information, see "About GitHub Advanced Security."

Nota: Escaneo de código se encuentra acutalmente en beta y está sujeto a cambios. If your organization has an Advanced Security license, you can join the beta program.

About escaneo de código

Escaneo de código is a feature that you use to analyze the code in a GitHub repository to find security vulnerabilities and coding errors. Any problems identified by the analysis are shown in Servidor de GitHub Enterprise.

You can configure escaneo de código to run CodeQL analysis and third-party analysis. Escaneo de código also supports running analysis natively using GitHub Actions or externally using existing CI/CD infrastructure. The table below summarizes all the options available to users when you configure tu instancia de servidor de GitHub Enterprise to allow escaneo de código using actions.

Type of analysis Options for generating alerts
CodeQL Using GitHub Actions (see "Enabling escaneo de código using actions") or using the CodeQL runner in a third-party continuous integration (CI) system (see "Running code scanning in your CI system").
Third‑party Using GitHub Actions (see "Enabling escaneo de código using actions") or generated externally and uploaded to GitHub Enterprise (see "Uploading a SARIF file to GitHub").

Prerequisites for escaneo de código

Running escaneo de código using GitHub Actions

Setting up a self-hosted runner

Servidor de GitHub Enterprise can run escaneo de código using a GitHub Actions workflow. First, you need to provision one or more self-hosted GitHub Actions runners in your environment. You can provision self-hosted runners at the repository, organization, or enterprise account level. For more information, see "About self-hosted runners" and "Adding self-hosted runners."

You must ensure that Git is in the PATH variable on any self-hosted runners you use to run CodeQL actions.

Provisioning the actions for escaneo de código

If you want to use actions to run escaneo de código on Servidor de GitHub Enterprise, the actions must be available on your appliance.

The CodeQL action is included in your installation of Servidor de GitHub Enterprise. If Servidor de GitHub Enterprise has access to the internet, the action will automatically download the CodeQL bundle required to perform analysis. Alternatively, you can use a synchronization tool to make the CodeQL analysis bundle available locally. For more information, see "Configuring CodeQL analysis on a server without internet access" below.

You can also make third-party actions available to users for escaneo de código, by setting up GitHub Connect. For more information, see "Configuring GitHub Connect to sync GitHub Actions" below.

Configuring CodeQL analysis on a server without internet access

If the server on which you are running Servidor de GitHub Enterprise is not connected to the internet, and you want to allow users to enable CodeQL escaneo de código for their repositories, you must use the CodeQL action sync tool to copy the CodeQL analysis bundle from GitHub.com to your server. The tool, and details of how to use it, are available at https://github.com/github/codeql-action-sync-tool.

If you set up the CodeQL action sync tool, you can use it to sync the latest releases of the CodeQL action and associated CodeQL analysis bundle. These are compatible with Servidor de GitHub Enterprise.

Configuring GitHub Connect to sync GitHub Actions

  1. If you want to download action workflows on demand from GitHub.com, you need to enable GitHub Connect. For more information, see "Enabling GitHub Connect."
  2. You'll also need to enable GitHub Actions for tu instancia de servidor de GitHub Enterprise. For more information, see "Getting started with GitHub Actions for Servidor de GitHub Enterprise."
  3. The next step is to configure access to actions on GitHub.com using GitHub Connect. For more information, see "Enabling automatic access to GitHub.com actions using GitHub Connect."
  4. Add a self-hosted runner to your repository, organization, or enterprise account. For more information, see "Adding self-hosted runners."

Running escaneo de código using the CodeQL runner

If you don't want to use GitHub Actions, you can run escaneo de código using the CodeQL runner.

The CodeQL runner is a command-line tool that you can add to your third-party CI/CD system. The tool runs CodeQL analysis on a checkout of a GitHub repository. For more information, see "Running escaneo de código in your CI system."

Did this doc help you?Privacy policy

Help us make these docs great!

All GitHub docs are open source. See something that's wrong or unclear? Submit a pull request.

Make a contribution

O, learn how to contribute.