1
0
mirror of synced 2025-12-19 18:10:59 -05:00
Files
docs/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/managing-code-scanning-alerts-for-your-repository.md
Kevin Heis ac2cd0e47d Deprecate GHES 3.3 (#34328)
Co-authored-by: Felicity Chapman <felicitymay@github.com>
Co-authored-by: Matt Pollard <mattpollard@users.noreply.github.com>
Co-authored-by: Sam Browning <106113886+sabrowning1@users.noreply.github.com>
2023-02-03 17:05:11 +00:00

17 KiB

title, shortTitle, intro, product, permissions, versions, miniTocMaxHeadingLevel, redirect_from, type, topics
title shortTitle intro product permissions versions miniTocMaxHeadingLevel redirect_from type topics
Managing code scanning alerts for your repository Manage alerts From the security view, {% ifversion delete-code-scanning-alerts %}you can view, fix, dismiss, or delete alerts {% else %}you can view, fix, or dismiss alerts{% endif %} for potential vulnerabilities or errors in your project's code. {% data reusables.gated-features.code-scanning %} If you have write permission to a repository you can manage {% data variables.product.prodname_code_scanning %} alerts for that repository.
fpt ghes ghae ghec
* * * *
3
/github/managing-security-vulnerabilities/managing-alerts-from-automated-code-scanning
/github/finding-security-vulnerabilities-and-errors-in-your-code/managing-alerts-from-code-scanning
/github/finding-security-vulnerabilities-and-errors-in-your-code/managing-code-scanning-alerts-for-your-repository
/code-security/secure-coding/managing-code-scanning-alerts-for-your-repository
/code-security/secure-coding/automatically-scanning-your-code-for-vulnerabilities-and-errors/managing-code-scanning-alerts-for-your-repository
how_to
Advanced Security
Code scanning
Alerts
Repositories

{% data reusables.code-scanning.beta %}

Viewing the alerts for a repository

Anyone with read permission for a repository can see {% data variables.product.prodname_code_scanning %} annotations on pull requests. For more information, see "Triaging {% data variables.product.prodname_code_scanning %} alerts in pull requests."

You need write permission to view a summary of all the alerts for a repository on the Security tab.

By default, the code scanning alerts page is filtered to show alerts for the default branch of the repository only.

{% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-security %} {% data reusables.repositories.sidebar-code-scanning-alerts %}

  1. Optionally, use the free text search box or the drop-down menus to filter alerts. For example, you can filter by the tool that was used to identify alerts. Filter by tool {% data reusables.code-scanning.explore-alert %} Summary of alerts

{% ifversion fpt or ghec or ghes > 3.4 or ghae > 3.4 %} {% data reusables.code-scanning.alert-default-branch %} The "Affected branches" section in an alert{% endif %}

  1. Optionally, if the alert highlights a problem with data flow, click Show paths to display the path from the data source to the sink where it's used. {% ifversion fpt or ghec or ghes > 3.4 or ghae > 3.4 %} The "Show paths" link on an alert {% else %} The "Show paths" link on an alert {% endif %}
  2. Alerts from {% data variables.product.prodname_codeql %} analysis include a description of the problem. Click Show more for guidance on how to fix your code. Details for an alert

For more information, see "About {% data variables.product.prodname_code_scanning %} alerts."

{% note %}

Note: For {% data variables.product.prodname_code_scanning %} analysis with {% data variables.product.prodname_codeql %}, you can see information about the latest run in a header at the top of the list of {% data variables.product.prodname_code_scanning %} alerts for the repository.

For example, you can see when the last scan ran, the number of lines of code analyzed compared to the total number of lines of code in your repository, and the total number of alerts that were generated. UI banner

{% endnote %}

Filtering {% data variables.product.prodname_code_scanning %} alerts

You can filter the alerts shown in the {% data variables.product.prodname_code_scanning %} alerts view. This is useful if there are many alerts as you can focus on a particular type of alert. There are some predefined filters and a range of keywords that you can use to refine the list of alerts displayed.

  • To use a predefined filter, click Filters, or a filter shown in the header of the list of alerts, and choose a filter from the drop-down list. {% ifversion fpt or ghes or ghec %}Predefined filters {% else %}Predefined filters{% endif %}
  • To use a keyword, either type directly in the filters text box, or:
    1. Click in the filters text box to show a list of all available filter keywords.
    2. Click the keyword you want to use and then choose a value from the drop-down list. Keyword filters list

The benefit of using keyword filters is that only values with results are shown in the drop-down lists. This makes it easy to avoid setting filters that find no results.

If you enter multiple filters, the view will show alerts matching all these filters. For example, is:closed severity:high branch:main will only display closed high-severity alerts that are present on the main branch. The exception is filters relating to refs (ref, branch and pr): is:open branch:main branch:next will show you open alerts from both the main branch and the next branch.

{% ifversion fpt or ghec or ghes > 3.4 or ghae > 3.4 %} {% data reusables.code-scanning.filter-non-default-branches %} {% endif %}

{% ifversion fpt or ghes or ghec %}

You can prefix the tag filter with - to exclude results with that tag. For example, -tag:style only shows alerts that do not have the style tag{% ifversion codeql-ml-queries %} and -tag:experimental will omit all experimental alerts. For more information, see "About {% data variables.product.prodname_code_scanning %} alerts."{% else %}.{% endif %}

{% endif %}

Restricting results to application code only

You can use the "Only alerts in application code" filter or autofilter:true keyword and value to restrict results to alerts in application code. See "About labels for alerts not in application code" above for more information about the types of code that are not application code.

{% ifversion fpt or ghes or ghec %}

Searching {% data variables.product.prodname_code_scanning %} alerts

You can search the list of alerts. This is useful if there is a large number of alerts in your repository, or if you don't know the exact name for an alert for example. {% data variables.product.product_name %} performs the free text search across:

  • The name of the alert
  • The alert details (this also includes the information hidden from view by default in the Show more collapsible section) {% ifversion fpt or ghec or ghes > 3.4 or ghae > 3.4 %} The alert information used in searches {% else %} The alert information used in searches {% endif %}
Supported search Syntax example Results
Single word search injection Returns all the alerts containing the word injection
Multiple word search sql injection Returns all the alerts containing sql or injection
Exact match search
(use double quotes)
"sql injection" Returns all the alerts containing the exact phrase sql injection
OR search sql OR injection Returns all the alerts containing sql or injection
AND search sql AND injection Returns all the alerts containing both words sql and injection

{% tip %}

Tips:

  • The multiple word search is equivalent to an OR search.
  • The AND search will return results where the search terms are found anywhere, in any order in the alert name or details.

{% endtip %}

{% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-security %} {% data reusables.repositories.sidebar-code-scanning-alerts %}

  1. To the right of the Filters drop-down menus, type the keywords to search for in the free text search box. The free text search box
  2. Press return. The alert listing will contain the open {% data variables.product.prodname_code_scanning %} alerts matching your search criteria.

{% endif %}

{% ifversion code-scanning-task-lists %}

Tracking {% data variables.product.prodname_code_scanning %} alerts in issues

{% data reusables.code-scanning.beta-alert-tracking-in-issues %} {% data reusables.code-scanning.github-issues-integration %} {% data reusables.code-scanning.alert-tracking-link %}

{% endif %}

Fixing an alert

Anyone with write permission for a repository can fix an alert by committing a correction to the code. If the repository has {% data variables.product.prodname_code_scanning %} scheduled to run on pull requests, it's best to raise a pull request with your correction. This will trigger {% data variables.product.prodname_code_scanning %} analysis of the changes and test that your fix doesn't introduce any new problems. For more information, see "Customizing {% data variables.product.prodname_code_scanning %}" and "Triaging {% data variables.product.prodname_code_scanning %} alerts in pull requests."

If you have write permission for a repository, you can view fixed alerts by viewing the summary of alerts and clicking Closed. For more information, see "Viewing the alerts for a repository." The "Closed" list shows fixed alerts and alerts that users have dismissed.

You can use the free text search or the filters to display a subset of alerts and then in turn mark all matching alerts as closed.

Alerts may be fixed in one branch but not in another. You can use the "Branch" filter, on the summary of alerts, to check whether an alert is fixed in a particular branch.

Filtering alerts by branch

{% ifversion fpt or ghec or ghes > 3.4 or ghae > 3.4 %} {% data reusables.code-scanning.filter-non-default-branches %} {% endif %}

{% ifversion fpt or ghes > 3.4 or ghae > 3.4 or ghec %} {% note %}

Note: If you run code scanning using multiple configurations, then sometimes an alert will have multiple analysis origins. Unless you run all configurations regularly, you may see alerts that are fixed in one analysis origin but not in another. For more information, see "About analysis origins."

{% endnote %} {% endif %}

Dismissing {% ifversion delete-code-scanning-alerts %}or deleting{% endif %} alerts

There are two ways of closing an alert. You can fix the problem in the code, or you can dismiss the alert. {% ifversion delete-code-scanning-alerts %}Alternatively, if you have admin permissions for the repository, you can delete alerts. Deleting alerts is useful in situations where you have set up a {% data variables.product.prodname_code_scanning %} tool and then decided to remove it, or where you have configured {% data variables.product.prodname_codeql %} analysis with a larger set of queries than you want to continue using, and you've then removed some queries from the tool. In both cases, deleting alerts allows you to clean up your {% data variables.product.prodname_code_scanning %} results. You can delete alerts from the summary list within the Security tab.{% endif %}

Dismissing an alert is a way of closing an alert that you don't think needs to be fixed. {% data reusables.code-scanning.close-alert-examples %} You can dismiss alerts from {% data variables.product.prodname_code_scanning %} annotations in code, or from the summary list within the Security tab.

When you dismiss an alert:

  • It's dismissed in all branches.
  • The alert is removed from the number of current alerts for your project.
  • The alert is moved to the "Closed" list in the summary of alerts, from where you can reopen it, if required.
  • The reason why you closed the alert is recorded.{% ifversion comment-dismissed-code-scanning-alert %}
  • Optionally, you can comment on a dismissal to record the context of an alert dismissal.{% endif %}
  • Next time {% data variables.product.prodname_code_scanning %} runs, the same code won't generate an alert.

{% ifversion delete-code-scanning-alerts %}When you delete an alert:

  • It's deleted in all branches.
  • The alert is removed from the number of current alerts for your project.
  • It is not added to the "Closed" list in the summary of alerts.
  • If the code that generated the alert stays the same, and the same {% data variables.product.prodname_code_scanning %} tool runs again without any configuration changes, the alert will be shown again in your analysis results.{% endif %}

To dismiss {% ifversion delete-code-scanning-alerts %}or delete{% endif %} alerts:

{% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-security %} {% data reusables.repositories.sidebar-code-scanning-alerts %}{% ifversion delete-code-scanning-alerts %}

  1. If you have admin permissions for the repository, and you want to delete alerts for this {% data variables.product.prodname_code_scanning %} tool, select some or all of the check boxes and click Delete.

    Deleting alerts

    Optionally, you can use the free text search or the filters to display a subset of alerts and then delete all matching alerts at once. For example, if you have removed a query from {% data variables.product.prodname_codeql %} analysis, you can use the "Rule" filter to list just the alerts for that query and then select and delete all of those alerts.

{% ifversion ghes or ghae %} Filter alerts by rule {% else %} Filter alerts by rule {% endif %}{% endif %}

  1. If you want to dismiss an alert, it's important to explore the alert first, so that you can choose the correct dismissal reason. Click the alert you'd like to explore. Open an alert from the summary list {%- ifversion comment-dismissed-code-scanning-alert %}

  2. Review the alert, then click Dismiss alert and choose, or type, a reason for closing the alert. Screenshot of code scanning alert with dropdown to choose dismissal reason emphasized {%- else %}

  3. Review the alert, then click Dismiss and choose a reason for closing the alert. Choosing a reason for dismissing an alert {%- endif %} {% data reusables.code-scanning.choose-alert-dismissal-reason %}

    {% data reusables.code-scanning.false-positive-fix-codeql %}

Dismissing multiple alerts at once

If a project has multiple alerts that you want to dismiss for the same reason, you can bulk dismiss them from the summary of alerts. Typically, you'll want to filter the list and then dismiss all of the matching alerts. For example, you might want to dismiss all of the current alerts in the project that have been tagged for a particular Common Weakness Enumeration (CWE) vulnerability.

Further reading