Skip to main content

Tracking code scanning alerts in issues using task lists

You can add code scanning alerts to issues using task lists. This makes it easy to create a plan for development work that includes fixing alerts.

If you have write permission to a repository you can track escaneo de código alerts in issues using task lists.

El Escaneo de código se encuentra disponible para todos los repositorios públicos y para los privados que pertenecen a organizaciones en donde se habilitó la GitHub Advanced Security. Para obtener más información, consulta la sección "Acerca de GitHub Advanced Security".

Note: The tracking of escaneo de código alerts in issues is in beta and subject to change.

Esta característica es compatible con la ejecución nativa de análisis utilizando GitHub Actions o externamente utilizando infraestructura de IC/DC, así como herramientas del escaneo de código de terceros, pero no de herramientas de rastreo de terceros.

About tracking escaneo de código alerts in issues

Escaneo de código alerts integrate with task lists in Propuestas de GitHub to make it easy for you to prioritize and track alerts with all your development work. Para obtener más información acerca de los informes de problemas, consulta la sección "Acerca de los informes de problemas".

To track a code scanning alert in an issue, add the URL for the alert as a task list item in the issue. Para obtener más información acerca de las listas de tareas, consulta la sección "Acerca de las listas de tareas".

You can also create a new issue to track an alert:

  • From a escaneo de código alert, which automatically adds the code scanning alert to a task list in the new issue. For more information, see "Creating a tracking issue from a escaneo de código alert" below.

  • Via the API as you normally would, and then provide the code scanning link within the body of the issue. You must use the task list syntax to create the tracked relationship:

    • - [ ] <full-URL- to-the-code-scanning-alert>
    • For example, if you add - [ ] https://github.com/octocat-org/octocat-repo/security/code-scanning/17 to an issue, the issue will track the code scanning alert that has an ID number of 17 in the "Security" tab of the octocat-repo repository in the octocat-org organization.

You can use more than one issue to track the same escaneo de código alert, and issues can belong to different repositories from the repository where the escaneo de código alert was found.

GitHub provides visual cues in different locations of the user interface to indicate when you are tracking escaneo de código alerts in issues.

  • The code scanning alerts list page will show which alerts are tracked in issues so that you can view at a glance which alerts still require processing.

    Tracked in pill on code scanning alert page

  • A "tracked in" section will also show in the corresponding alert page.

    Tracked in section on code scanning alert page

  • On the tracking issue, GitHub displays a security badge icon in the task list and on the hovercard.

    Only users with write permissions to the repository will see the unfurled URL to the alert in the issue, as well as the hovercard. For users with read permissions to the repository, or no permissions at all, the alert will appear as a plain URL.

    The color of the icon is grey because an alert has a status of "open" or "closed" on every branch. The issue tracks an alert, so the alert cannot have a single open/closed state in the issue. If the alert is closed on one branch, the icon color will not change.

    Hovercard in tracking issue

The status of the tracked alert won't change if you change the checkbox state of the corresponding task list item (checked/unchecked) in the issue.

Creating a tracking issue from a code scanning alert

  1. En GitHub.com, visita la página principal del repositorio.

  2. Debajo de tu nombre de repositorio, da clic en Seguridad. Pestaña de seguridad

  3. En la barra lateral izquierda, da clic en alertas de escaneo de código. pestaña de "Alertas de escaneo de código"

  4. Debajo de "Escaneo de código", da clic en la alerta que quisieras explorar.

  5. Optionally, to find the alert to track, you can use the free-text search or the drop-down menus to filter and locate the alert. For more information, see "Managing code scanning alerts for your repository."

  6. Towards the top of the page, on the right side, click Create issue. Create a tracking issue for the code scanning alert GitHub automatically creates an issue to track the alert and adds the alert as a task list item. GitHub prepopulates the issue:

    • The title contains the name of the escaneo de código alert.
    • The body contains the task list item with the full URL to the escaneo de código alert.
  7. Optionally, edit the title and the body of the issue.

    Warning: You may want to edit the title of the issue as it may expose security information. You can also edit the body of the issue, but do not edit the task list item or the issue will no longer track the alert.

    New tracking issue for the code scanning alert

  8. Click Submit new issue.