diff --git a/assets/images/help/repository/secret-scanning-resolve-alert-ghe.png b/assets/images/enterprise/3.2/repository/secret-scanning-resolve-alert-ghe.png similarity index 100% rename from assets/images/help/repository/secret-scanning-resolve-alert-ghe.png rename to assets/images/enterprise/3.2/repository/secret-scanning-resolve-alert-ghe.png diff --git a/assets/images/help/repository/secret-scanning-dismiss-alert.png b/assets/images/help/repository/secret-scanning-dismiss-alert.png new file mode 100644 index 0000000000..eac0b1a0d1 Binary files /dev/null and b/assets/images/help/repository/secret-scanning-dismiss-alert.png differ diff --git a/assets/images/help/repository/secret-scanning-dismissal-comment.png b/assets/images/help/repository/secret-scanning-dismissal-comment.png new file mode 100644 index 0000000000..dc4ab067e3 Binary files /dev/null and b/assets/images/help/repository/secret-scanning-dismissal-comment.png differ diff --git a/content/code-security/secret-scanning/managing-alerts-from-secret-scanning.md b/content/code-security/secret-scanning/managing-alerts-from-secret-scanning.md index 004ef9e541..188283b50a 100644 --- a/content/code-security/secret-scanning/managing-alerts-from-secret-scanning.md +++ b/content/code-security/secret-scanning/managing-alerts-from-secret-scanning.md @@ -33,14 +33,14 @@ shortTitle: Manage secret alerts {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-security %} 1. In the left sidebar, click **Secret scanning alerts**. - {% ifversion fpt or ghes or ghec %} + {% ifversion ghes or ghec %} !["Secret scanning alerts" tab](/assets/images/help/repository/sidebar-secrets.png) {% endif %} {% ifversion ghae %} !["Secret scanning alerts" tab](/assets/images/enterprise/github-ae/repository/sidebar-secrets-ghae.png) {% endif %} 1. Under "Secret scanning" click the alert you want to view. - {% ifversion fpt or ghec %} + {% ifversion ghec %} ![List of alerts from secret scanning](/assets/images/help/repository/secret-scanning-click-alert.png) {% endif %} {% ifversion ghes %} @@ -48,14 +48,21 @@ shortTitle: Manage secret alerts {% endif %} {% ifversion ghae %} ![List of alerts from secret scanning](/assets/images/enterprise/github-ae/repository/secret-scanning-click-alert-ghae.png) - {% endif %} -1. Optionally, select the {% ifversion fpt or ghec %}"Close as"{% elsif ghes or ghae %}"Mark as"{% endif %} drop-down menu and click a reason for resolving an alert. - {% ifversion fpt or ghec %} - ![Drop-down menu for resolving an alert from secret scanning](/assets/images/help/repository/secret-scanning-resolve-alert.png) - {% endif %} - {% ifversion ghes or ghae %} - ![Drop-down menu for resolving an alert from secret scanning](/assets/images/help/repository/secret-scanning-resolve-alert-ghe.png) - {% endif %} + {% endif %}{% ifversion secret-scanning-dismissal-comment %} +1. To dismiss an alert, select the "Dismiss alert" dropdown menu and click a reason for resolving an alert. + + ![Screenshot of the dropdown menu for dismissing an alert from secret scanning](/assets/images/help/repository/secret-scanning-dismiss-alert.png){% else %} +1. To dismiss an alert, select the "Mark as" dropdown menu and click a reason for resolving an alert. + + ![Screenshot of the dropdown menu for resolving an alert from secret scanning](/assets/images/enterprise/3.2/repository/secret-scanning-resolve-alert-ghe.png) + + {% endif %}{% ifversion secret-scanning-dismissal-comment %} +1. Optionally, add a dismissal comment. The dismissal comment will be added to the alert timeline and can be used as justification during auditing and reporting. You can view the history of all dismissed alerts and dismissal comments in the alert timeline. You can also retrieve or set a comment by using the {% data variables.product.prodname_secret_scanning_caps %} API. The comment is contained in the `resolution_comment` field. For more information, see "[{% data variables.product.prodname_secret_scanning_caps %}](/rest/secret-scanning#update-a-secret-scanning-alert)" in the REST API documentation. + + ![Screenshot showing how to dismiss an alert via the "Dismiss alert" dropdown, with the option to add a dismissal comment](/assets/images/help/repository/secret-scanning-dismissal-comment.png) + +1. Click **Dismiss alert**. +{% endif %} ## Securing compromised secrets diff --git a/data/features/secret-scanning-dismissal-comment.yml b/data/features/secret-scanning-dismissal-comment.yml new file mode 100644 index 0000000000..9a0117ef35 --- /dev/null +++ b/data/features/secret-scanning-dismissal-comment.yml @@ -0,0 +1,6 @@ +# Reference: #7524. +# Documentation for allowing users to add a comment when dismissing a secret scanning alert. +versions: + ghec: '*' + ghes: '>=3.8' + ghae: '>=3.8'