text stringlengths 12 91.7k | metadata dict |
|---|---|
Anyone with read permission for a repository can see annotations on pull requests. For more information, see AUTOTITLE.
Viewing the alerts for a repository
You need write permission to view a summary of all the alerts for a repository on the tab.
By default, the alerts page is filtered to show alerts for the defaul... | {
"source": "github-docs/code-security/how-tos/manage-security-alerts/manage-code-scanning-alerts/assess-alerts.md",
"title": "Assessing code scanning alerts for your repository"
} |
Disabling agentic autofix
Disabling agentic autofix can be done in two ways:
1. By disabling since agentic autofix relies on the same underlying setting. For instructions, see the sections below.
1. By opting repositories out of . See AUTOTITLE.
For more information about agentic autofix, see AUTOTITLE.
Disabling
Yo... | {
"source": "github-docs/code-security/how-tos/manage-security-alerts/manage-code-scanning-alerts/disabling-autofix-for-code-scanning.md",
"title": "Disabling autofix for code scanning security alerts"
} |
[!NOTE]
Configuring delegated dismissal for a repository
[!NOTE] If an organization owner configures delegated alert dismissal via an enforced security configuration, the settings can't be changed at the repository level.
1. Under "", click Enable for "Prevent direct alert dismissals".
Configuring delegated dismiss... | {
"source": "github-docs/code-security/how-tos/manage-security-alerts/manage-code-scanning-alerts/enable-delegated-alert-dismissal.md",
"title": "Enabling delegated alert dismissal for code scanning"
} |
Asking about alerts
With a license, you can ask for help to better understand security alerts, including alerts, in repositories in your organization. See AUTOTITLE.
Fixing alerts with
[!NOTE]
This feature is in and subject to change. and must be available in the repository.
You can assign a alert to to h... | {
"source": "github-docs/code-security/how-tos/manage-security-alerts/manage-code-scanning-alerts/resolve-alerts.md",
"title": "Resolving code scanning alerts"
} |
When identifies a vulnerability, you can link it to a new or existing issue. This makes security fixes visible in your planning and project boards alongside your team's regular development work. For more information about how alert tracking works, see AUTOTITLE.
Creating an issue from an alert
Create a new issue dir... | {
"source": "github-docs/code-security/how-tos/manage-security-alerts/manage-code-scanning-alerts/track-alerts-in-issues.md",
"title": "Linking code scanning alerts to GitHub issues"
} |
Depending on your configuration, results may appear as check results and annotations on pull requests. For more information, see AUTOTITLE.
Viewing results of the check
For all configurations of , the check that contains the results of is: results. The results for each analysis tool used are shown separately. Any ... | {
"source": "github-docs/code-security/how-tos/manage-security-alerts/manage-code-scanning-alerts/triage-alerts-in-pull-requests.md",
"title": "Triaging code scanning alerts in pull requests"
} |
[!NOTE]
Configuring delegated dismissal for a repository
[!NOTE] If an organization owner configures delegated alert dismissal via an enforced security configuration, the settings can't be changed at the repository level.
1. In the "" section, next to "Prevent direct alert dismissals", click Enable.
Configuring dele... | {
"source": "github-docs/code-security/how-tos/manage-security-alerts/manage-dependabot-alerts/enable-delegated-alert-dismissal.md",
"title": "Enabling delegated alert dismissal for Dependabot"
} |
Viewing for your repository
Viewing for your organization
1. Click the name of the organization you want to view.
Viewing for your enterprise
1. At the top of the page, click the tab.
Dismissing
1. Navigate to the view for your repository, organization, or enterprise.
1. Click the name of the you want to dism... | {
"source": "github-docs/code-security/how-tos/manage-security-alerts/manage-dependabot-alerts/manage-malware-alerts.md",
"title": "Managing Dependabot malware alerts"
} |
Managing automatically dismissed alerts
[!NOTE]
The page defaults to showing open alerts. To filter and view auto-dismissed alerts, you must first clear the is:open default filter from the view.
1. To filter to see all closed alerts, click Closed. Alternatively, use the is:closed filter query in the search bar.
... | {
"source": "github-docs/code-security/how-tos/manage-security-alerts/manage-dependabot-alerts/managing-automatically-dismissed-alerts.md",
"title": "Managing alerts that have been automatically dismissed by a Dependabot auto-triage rule"
} |
Your repository's tab lists all open and closed and corresponding . You can filter alerts by package, ecosystem, or manifest. You can sort the list of alerts, and you can click into specific alerts for more details. You can also dismiss or reopen alerts, either one by one or by selecting multiple alerts at once. For ... | {
"source": "github-docs/code-security/how-tos/manage-security-alerts/manage-dependabot-alerts/view-dependabot-alerts.md",
"title": "Viewing and updating Dependabot alerts"
} |
[!NOTE]
Alert dismissal requests expire after 1 week. After this, dismissal requests must be resubmitted.
Configuring delegated dismissal for a repository
[!NOTE] If an organization owner configures delegated alert dismissal via an enforced security configuration, the settings can't be changed at the repository level... | {
"source": "github-docs/code-security/how-tos/manage-security-alerts/manage-secret-scanning-alerts/enable-delegated-dismissal.md",
"title": "Enabling delegated alert dismissal for secret scanning"
} |
When detects a potential secret leak in your repository, staying informed about these alerts is crucial for maintaining your code's security. provides multiple notification channels to ensure you and your team are promptly alerted when secrets are found. You can customize how and when you receive these notifications ... | {
"source": "github-docs/code-security/how-tos/manage-security-alerts/manage-secret-scanning-alerts/monitoring-alerts.md",
"title": "Monitoring alerts from secret scanning"
} |
Fixing alerts
Once a secret has been committed to a repository, you should consider the secret compromised. recommends the following actions for compromised secrets:
1. Verify that the secret committed to is valid. Applies to tokens only. See Checking a secret's validity and Performing an on-demand validity check.
1... | {
"source": "github-docs/code-security/how-tos/manage-security-alerts/manage-secret-scanning-alerts/resolving-alerts.md",
"title": "Resolving alerts from secret scanning"
} |
You can find and filter through your repository's tab. To learn more about alerts and the different types you may encounter, see AUTOTITLE.
Viewing alerts
Alerts for are displayed under the tab of the repository.
1. In the left sidebar, under "Vulnerability alerts", click .
1. Optionally, toggle to "Generic" to se... | {
"source": "github-docs/code-security/how-tos/manage-security-alerts/manage-secret-scanning-alerts/viewing-alerts.md",
"title": "Viewing and filtering alerts from secret scanning"
} |
QualifierDescription
--------------------
bypassedDisplay alerts for secrets where push protection has been bypassed (true). For more information, see AUTOTITLE.
isDisplay alerts that are open (open), closed (closed), found in a public repository (publicly-leaked), or found in more than one repository within the same o... | {
"source": "github-docs/code-security/how-tos/manage-security-alerts/manage-secret-scanning-alerts/viewing-alerts.md",
"title": "Viewing and filtering alerts from secret scanning"
} |
Creating a security campaign
Security campaigns are created and managed from the tab for your organization.
You choose the alerts that you want to include in the campaign by using either:
Campaign templates: Campaign templates contain filters for the most common alert selections. For code campaigns, they also all inc... | {
"source": "github-docs/code-security/how-tos/manage-security-alerts/remediate-alerts-at-scale/creating-managing-security-campaigns.md",
"title": "Creating and managing security campaigns"
} |
Security overview can show alerts across many repositories in your organization or enterprise. Filtering helps you focus on specific alerts based on severity, alert type, repository characteristics, and other factors.
You can combine multiple filters to narrow your results. For example, you can show only critical in p... | {
"source": "github-docs/code-security/how-tos/manage-security-alerts/remediate-alerts-at-scale/filtering-alerts-in-security-overview.md",
"title": "Filtering alerts in security overview"
} |
Viewing alerts in a security campaign
When a campaign targets security alerts in a repository that you have write access to, you can navigate to the list of repository alerts in the campaign.
Display the tab for the repository and click one of the campaigns under "Campaigns" in the sidebar.
If you have write access ... | {
"source": "github-docs/code-security/how-tos/manage-security-alerts/remediate-alerts-at-scale/fixing-alerts-in-security-campaign.md",
"title": "Fixing alerts in a security campaign"
} |
Prerequisites
To receive and manage alert dismissal requests, you need to enable delegated alert dismissal. For an introduction to delegated alert dismissal and enablement instructions for specific features, see:
AUTOTITLE
AUTOTITLE
AUTOTITLE
Reviewing requests for an organization
1. Optionally, to filter requests ... | {
"source": "github-docs/code-security/how-tos/manage-security-alerts/remediate-alerts-at-scale/review-alert-dismissal-requests.md",
"title": "Reviewing alert dismissal requests"
} |
Tracking campaigns across your organization
The tracking view helps you quickly assess the health of your organization’s campaigns. You can use it to identify campaigns with a high number of open alerts, check whether work has started, and determine whether campaigns are on track to meet their due dates.
To display the... | {
"source": "github-docs/code-security/how-tos/manage-security-alerts/remediate-alerts-at-scale/tracking-security-campaigns.md",
"title": "Tracking security campaigns"
} |
1. In the left sidebar, under "Reporting", click Security policy.
1. Click Start setup.
1. In the new SECURITY.md file, add information about supported versions of your project and how to report a vulnerability.
Further reading
AUTOTITLE
AUTOTITLE
AUTOTITLE | {
"source": "github-docs/code-security/how-tos/report-and-fix-vulnerabilities/configure-vulnerability-reporting/add-security-policy.md",
"title": "Adding a security policy to your repository"
} |
Enabling private vulnerability reporting gives security researchers a secure, structured way to disclose vulnerabilities directly in your repository. Once enabled, researchers can submit reports through your repository's private vulnerability reporting form without resorting to public disclosure or informal channels. F... | {
"source": "github-docs/code-security/how-tos/report-and-fix-vulnerabilities/configure-vulnerability-reporting/configure-for-a-repository.md",
"title": "Configuring private vulnerability reporting for a repository"
} |
This article applies to repository-level security advisories in a public repository. To edit a global advisory in the , see AUTOTITLE.
Collaborators have write permissions to the security advisory. For more information, see AUTOTITLE.
[!NOTE]
For more information about removing a collaborator on a security advisory,... | {
"source": "github-docs/code-security/how-tos/report-and-fix-vulnerabilities/fix-reported-vulnerabilities/add-collaborators.md",
"title": "Adding a collaborator to a repository security advisory"
} |
<!--Marketing-LINK: From /features/security/software-supply-chain page "Browsing security vulnerabilities in the GitHub Advisory Database".--
Accessing an advisory in the
You can access any advisory in the .
1. Navigate to https://github.com/advisories.
1. Optionally, to filter the list of advisories, use the search ... | {
"source": "github-docs/code-security/how-tos/report-and-fix-vulnerabilities/fix-reported-vulnerabilities/browse-advisory-database.md",
"title": "Browsing security advisories in the GitHub Advisory Database"
} |
Creating a security advisory
You can also use the REST API to create repository security advisories. For more information, see AUTOTITLE.
1. Click New draft security advisory to open the draft advisory form. The fields marked with an asterisk are required.
1. In the Title field, type a title for your security advisory.... | {
"source": "github-docs/code-security/how-tos/report-and-fix-vulnerabilities/fix-reported-vulnerabilities/create-repository-advisory.md",
"title": "Creating a repository security advisory"
} |
If you publish a security advisory in error, you can delete the security advisory by contacting .
Further reading
AUTOTITLE | {
"source": "github-docs/code-security/how-tos/report-and-fix-vulnerabilities/fix-reported-vulnerabilities/delete-repository-advisories.md",
"title": "Deleting a repository security advisory"
} |
Editing advisories in the
1. Navigate to https://github.com/advisories.
1. Select the security advisory you would like to contribute to.
1. On the right-hand side of the page, click the Suggest improvements for this vulnerability link.
1. In the "Improve security advisory" form, make the desired improvements. You can ... | {
"source": "github-docs/code-security/how-tos/report-and-fix-vulnerabilities/fix-reported-vulnerabilities/edit-advisory-database.md",
"title": "Editing security advisories in the GitHub Advisory Database"
} |
Editing a security advisory
You can also use the REST API to edit repository security advisories. For more information, see AUTOTITLE.
1. In the "Security Advisories" list, click the name of the security advisory you'd like to edit.
1. In the upper-right corner of the details for the security advisory, click Edit advis... | {
"source": "github-docs/code-security/how-tos/report-and-fix-vulnerabilities/fix-reported-vulnerabilities/edit-repository-advisories.md",
"title": "Editing a repository security advisory"
} |
When a security researcher reports a vulnerability privately, you are notified and can choose to either accept it, ask more questions, or reject it. If you accept the report, you're ready to collaborate on a fix for the vulnerability in private with the security researcher.
For more information about configuring notifi... | {
"source": "github-docs/code-security/how-tos/report-and-fix-vulnerabilities/fix-reported-vulnerabilities/manage-vulnerability-reports.md",
"title": "Managing privately reported security vulnerabilities"
} |
<!--Marketing-LINK: From /features/security/software-supply-chain page "Publishing a security advisory".--
Prerequisites
Before you can publish a security advisory or request a CVE identification number, you must create a draft security advisory and provide information about the versions of your project affected by th... | {
"source": "github-docs/code-security/how-tos/report-and-fix-vulnerabilities/fix-reported-vulnerabilities/publish-repository-advisory.md",
"title": "Publishing a repository security advisory"
} |
Removing a collaborator from a security advisory
1. In the "Security Advisories" list, click the name of the security advisory you'd like to remove a collaborator from.
1. On the right side of the page, under "Collaborators", find the name of the user or team you'd like to remove from the security advisory.
1. Next to ... | {
"source": "github-docs/code-security/how-tos/report-and-fix-vulnerabilities/fix-reported-vulnerabilities/remove-collaborators.md",
"title": "Removing a collaborator from a repository security advisory"
} |
[!NOTE]
If you have admin or security permissions for a public repository, you don’t need to submit a vulnerability report. Instead, create a draft security advisory directly. See AUTOTITLE.
Private vulnerability reporting is separate from a repository’s SECURITY.md file. You can only report vulnerabilities private... | {
"source": "github-docs/code-security/how-tos/report-and-fix-vulnerabilities/report-privately.md",
"title": "Privately reporting a security vulnerability"
} |
[!NOTE]
is currently in and subject to change. During , will not be billed, although scans will consume minutes.
Previously, policies also controlled access to . Those existing policy settings are automatically applied to the standalone policies.
1. Navigate to your enterprise. For example, from https://gith... | {
"source": "github-docs/code-security/how-tos/secure-at-scale/configure-enterprise-security/configure-specific-tools/allow-github-code-quality-in-enterprise.md",
"title": "Allowing use of {% data variables.product.prodname_code_quality %} in your enterprise"
} |
About dependency review
Some additional features, such as license checks, blocking of pull requests, and CI/CD integration, are available with the dependency review action.
Checking whether your license includes
Prerequisites for dependency review
A license for or (see AUTOTITLE).
The dependency graph enabled fo... | {
"source": "github-docs/code-security/how-tos/secure-at-scale/configure-enterprise-security/configure-specific-tools/configure-dependency-review.md",
"title": "Configuring dependency review for your appliance"
} |
About updates
You can use to fix vulnerabilities and keep dependencies updated to the latest version in . require with self-hosted runners set up for to use. alerts and security updates use information from the accessed using . For more information, see AUTOTITLE and AUTOTITLE.
Alternatively, if your instance h... | {
"source": "github-docs/code-security/how-tos/secure-at-scale/configure-enterprise-security/configure-specific-tools/configure-limited-internet-access.md",
"title": "Configuring Dependabot to work with limited internet access"
} |
About
If someone checks a secret with a known pattern into a repository, catches the secret as it's checked in, and helps you mitigate the impact of the leak. Repository administrators are notified about any commit that contains a secret, and they can quickly view all detected secrets in the tab for the repository. ... | {
"source": "github-docs/code-security/how-tos/secure-at-scale/configure-enterprise-security/configure-specific-tools/configure-secret-scanning.md",
"title": "Configuring secret scanning for your appliance"
} |
<!--The CodeQL CLI man pages include a link to a section in this article. If you rename this article,
make sure that you also update the MS short link: https://aka.ms/code-scanning-docs/configuring-ghes.--
About
You can configure to run analysis and third-party analysis. also supports running analysis natively usi... | {
"source": "github-docs/code-security/how-tos/secure-at-scale/configure-enterprise-security/configure-specific-tools/configuring-code-scanning-for-your-appliance.md",
"title": "{% ifversion ghes %}Configuring code scanning for your appliance{% elsif default-setup-self-hosted-runners-GHEC %}Configuring self-hosted ... |
About the dependency graph
For more information, see AUTOTITLE
After you enable the dependency graph for your enterprise, you can enable to detect insecure dependencies in your repository and automatically fix the vulnerabilities. For more information, see AUTOTITLE.
You can enable the dependency graph via the or th... | {
"source": "github-docs/code-security/how-tos/secure-at-scale/configure-enterprise-security/configure-specific-tools/enable-dependency-graph.md",
"title": "Enabling the dependency graph for your enterprise"
} |
Configuring VNET for
This article provides step-by-step instructions for running on -hosted runners configured with VNET. The article explains:
How to create runner groups for your enterprise or organization with a VNET configuration.
How to create -hosted runners for in the runner group.
How to enable on large ... | {
"source": "github-docs/code-security/how-tos/secure-at-scale/configure-enterprise-security/configure-specific-tools/setting-dependabot-to-run-on-github-hosted-runners-using-vnet.md",
"title": "Setting up Dependabot to run on github-hosted action runners using the Azure Private Network"
} |
If are enabled for your enterprise, you can view all vulnerabilities that were downloaded to from the .
You can manually sync vulnerability data from to update the list.
Before you can view vulnerability data, you must enable . For more information, see AUTOTITLE.
1. In the left sidebar, under Site admin, click Vul... | {
"source": "github-docs/code-security/how-tos/secure-at-scale/configure-enterprise-security/configure-specific-tools/view-vulnerability-data.md",
"title": "Viewing the vulnerability data for your enterprise"
} |
About applying a
After you create a , you need to apply it to repositories in your enterprise to enable the configuration's settings on those repositories.
The repository list displays each repository's configuration status. For the full list of statuses and recommended actions, see AUTOTITLE.
Applying your to repos... | {
"source": "github-docs/code-security/how-tos/secure-at-scale/configure-enterprise-security/establish-complete-coverage/apply-custom-configuration.md",
"title": "Applying a custom security configuration to your enterprise"
} |
About additional settings for
There are some additional settings that cannot be applied to repositories using , so you must configure these settings separately:
Configuring a resource link for push protection
Controlling features for new repositories created in a user namespace
Specifying patterns to include in pu... | {
"source": "github-docs/code-security/how-tos/secure-at-scale/configure-enterprise-security/establish-complete-coverage/configure-additional-settings.md",
"title": "Configuring additional secret scanning settings for your enterprise"
} |
About
With , you can create collections of enablement settings for 's security products to meet the specific security needs of your enterprise. For example, you can create a different for each organization or group of organizations to reflect their unique security requirements and compliance obligations.
You can also... | {
"source": "github-docs/code-security/how-tos/secure-at-scale/configure-enterprise-security/establish-complete-coverage/create-custom-configuration.md",
"title": "Creating a custom security configuration for your enterprise"
} |
About enabling products
When you enable for your enterprise, repository administrators in all organizations can enable the features unless you set up a policy to restrict access. See AUTOTITLE.
For guidance on a phased deployment of , see AUTOTITLE.
Checking whether your license includes
1. If your license includes... | {
"source": "github-docs/code-security/how-tos/secure-at-scale/configure-enterprise-security/establish-complete-coverage/enabling-github-advanced-security-for-your-enterprise.md",
"title": "Enabling {% data variables.product.prodname_GHAS %} products for your enterprise"
} |
About deleting a
If you no longer need a , you can delete that configuration to ensure it will not be applied to any repositories in the future. If you want to delete a because you want to change the security enablement settings in that configuration, consider editing the configuration instead. For more information, ... | {
"source": "github-docs/code-security/how-tos/secure-at-scale/configure-enterprise-security/manage-your-coverage/delete-custom-configuration.md",
"title": "Deleting a custom security configuration"
} |
About editing a
After creating and applying a , you may need to edit the enablement settings for that configuration to better secure your repositories. Any changes you make to the enablement settings of a will automatically populate to all linked repositories.
Modifying your
1. In the "Configurations" section, clic... | {
"source": "github-docs/code-security/how-tos/secure-at-scale/configure-enterprise-security/manage-your-coverage/edit-custom-configuration.md",
"title": "Editing a custom security configuration"
} |
Prerequisites
Before enabling public monitoring, ensure your enterprise has:
or enabled
While not necessary, we recommend having at one verified domain configured (see AUTOTITLE) in order to get the full value for the feature.
Enabling public monitoring
1. Under "Additional Settings," toggle Public monitoring. | {
"source": "github-docs/code-security/how-tos/secure-at-scale/configure-enterprise-security/manage-your-coverage/enabling-public-monitoring-for-your-enterprise.md",
"title": "Enabling public monitoring for your enterprise"
} |
Generating an initial
Rerunning the
[!NOTE]
You can only generate a secret risk assessment report once every 90 days.
1. Towards the top right side of the existing report, click Rerun scan. | {
"source": "github-docs/code-security/how-tos/secure-at-scale/configure-organization-security/configure-specific-tools/assess-your-secret-risk.md",
"title": "Running the secret risk assessment for your organization"
} |
Generating an initial
Rerunning the
You can only generate a report once every 90 days.
1. Towards the top right side of the existing report, click Rerun scan.
Next steps
Now that you've generated a report for your organization, learn how to interpret the results. See AUTOTITLE. | {
"source": "github-docs/code-security/how-tos/secure-at-scale/configure-organization-security/configure-specific-tools/assess-your-vulnerability-risk.md",
"title": "Running the code security risk assessment for your organization"
} |
With default setup for , you can quickly secure code in repositories across your organization. For more information, see AUTOTITLE.
For repositories that are not suitable for default setup, you can configure advanced setup at the repository level, or at the organization level using a script.
Prerequisites
A repository... | {
"source": "github-docs/code-security/how-tos/secure-at-scale/configure-organization-security/configure-specific-tools/code-scanning-at-scale.md",
"title": "Configuring default setup for code scanning at scale"
} |
Using a script to enable advanced setup
For repositories that are not eligible for default setup, you can use a bulk configuration script to enable advanced setup across multiple repositories.
[!NOTE] To successfully execute the script, must be enabled for the organizationorganization or enterpriseinstance.
1. Identi... | {
"source": "github-docs/code-security/how-tos/secure-at-scale/configure-organization-security/configure-specific-tools/configuring-advanced-setup-for-code-scanning-with-codeql-at-scale.md",
"title": "Configuring advanced setup for code scanning with CodeQL at scale"
} |
You can enforce the use of the in your organization by setting up a repository ruleset that will require a workflow that runs dependency review to pass before pull requests can be merged. For more information about the action, see AUTOTITLE.
Prerequisites
You need to add the to one of the repositories in your organi... | {
"source": "github-docs/code-security/how-tos/secure-at-scale/configure-organization-security/configure-specific-tools/enforce-dependency-review.md",
"title": "Enforcing dependency review across an organization"
} |
What is the pricing calculator?
You can use the on the secret risk assessment page to estimate the monthly cost of for your organization. This tool allows you to preview costs based on your current repositories and active committers, so you can plan for purchase or rollout decisions.
For more information about , see ... | {
"source": "github-docs/code-security/how-tos/secure-at-scale/configure-organization-security/configure-specific-tools/estimate-price.md",
"title": "Estimating the price of Secret Protection"
} |
Prerequisites
Before you configure :
Run the free to inform your enablement strategy. See AUTOTITLE.
Review best practices for choosing pilot repositories. See AUTOTITLE.
Configuring
1. In the banner display, select the Get started dropdown menu, then click one of following enablement options:
For public repo... | {
"source": "github-docs/code-security/how-tos/secure-at-scale/configure-organization-security/configure-specific-tools/protect-your-secrets.md",
"title": "Pricing and enabling {% data variables.product.prodname_GH_secret_protection %}"
} |
You can see the most recent report on this page.
1. Click the or tab to switch between reports. | {
"source": "github-docs/code-security/how-tos/secure-at-scale/configure-organization-security/configure-specific-tools/viewing-your-security-risk-assessment-reports.md",
"title": "Viewing your security risk assessment reports"
} |
To learn how to create a , see AUTOTITLE.
Applying your to repositories in your organization
1. Click the Repositories tab.
1. Optionally, in the "Apply configurations" section, filter for specific repositories you would like to apply your to. To learn how to filter the repository table, see AUTOTITLE.
1. Select the... | {
"source": "github-docs/code-security/how-tos/secure-at-scale/configure-organization-security/establish-complete-coverage/apply-custom-configuration.md",
"title": "Applying a custom security configuration"
} |
Accessing the page for your organization
1. In the "Security" section of the sidebar, select the dropdown menu, then click .
Configuring global settings
You can customize several for :
Creating and managing
Grouping security updates
Enabling dependency updates on runners
Configuring the runner type for
Gr... | {
"source": "github-docs/code-security/how-tos/secure-at-scale/configure-organization-security/establish-complete-coverage/configure-global-settings.md",
"title": "Configuring global security settings for your organization"
} |
About
With , you can create collections of enablement settings for 's security products to meet the specific security needs of your organization. For example, you can create a different for each organization or group of organizations to reflect their unique security requirements and compliance obligations.
You can al... | {
"source": "github-docs/code-security/how-tos/secure-at-scale/configure-organization-security/establish-complete-coverage/create-custom-configuration.md",
"title": "Creating a custom security configuration"
} |
About the importance of providing access to private registries
When code in a repository has dependencies that are stored in a private registry, some security features need access to the registry to enable them to work effectively. Without access to all the dependencies of a repository, the effectiveness of (), defau... | {
"source": "github-docs/code-security/how-tos/secure-at-scale/configure-organization-security/manage-usage-and-access/giving-org-access-private-registries.md",
"title": "Giving security features access to private registries"
} |
Prerequisites
Before you can effectively manage your paid use of , you should understand how is billed. See AUTOTITLE.
Understanding your license usage
1. Click the Repositories tab.
1. In the "Apply configurations" section, your current license usage will be displayed. This screenshot shows metered usage. If you hav... | {
"source": "github-docs/code-security/how-tos/secure-at-scale/configure-organization-security/manage-usage-and-access/managing-your-github-advanced-security-license-usage.md",
"title": "Managing your paid use of {% data variables.product.prodname_AS %}"
} |
About deleting a
If you no longer need a , you can delete that configuration to ensure it will not be applied to any repositories in the future. If you are deleting a because you want to change the security enablement settings in that configuration, you can instead edit the configuration. For more information, see AU... | {
"source": "github-docs/code-security/how-tos/secure-at-scale/configure-organization-security/manage-your-coverage/delete-custom-configuration.md",
"title": "Deleting a custom security configuration"
} |
If you decide that the security needs of a repository are too specific for a to be useful, you can detach that repository from the linked configuration and instead manage security enablement settings at the repository level.
Detaching a repository from a will not change the existing security enablement settings for t... | {
"source": "github-docs/code-security/how-tos/secure-at-scale/configure-organization-security/manage-your-coverage/detach-security-configuration.md",
"title": "Detaching repositories from their security configurations"
} |
1. Under "", click the name of the you want to edit.
1. Edit the name and description of your as desired.
1. Edit the enablement settings of your as desired.
1. In the "Policy" section, you can modify the configuration's enforcement status. Enforcing a configuration will block repository owners from changing feature... | {
"source": "github-docs/code-security/how-tos/secure-at-scale/configure-organization-security/manage-your-coverage/edit-custom-configuration.md",
"title": "Editing a custom security configuration"
} |
You can filter the repository table in your organization to quickly find and manage specific repositories when applying or managing license usage in the organization. This article explains how to use filters in the repository table.
Filtering the repository table with the search bar
1. Click the Repositories tab.
1.... | {
"source": "github-docs/code-security/how-tos/secure-at-scale/configure-organization-security/manage-your-coverage/filter-repositories.md",
"title": "Filtering repositories in your organization using the repository table"
} |
Defining a custom pattern with
You can use AI to generate regular expressions based on a text description of the type of pattern you would like to detect, including optional example strings that should be detected. See AUTOTITLE.
Defining a custom pattern for a repository
Before defining a custom pattern, you must en... | {
"source": "github-docs/code-security/how-tos/secure-your-secrets/customize-leak-detection/define-custom-patterns.md",
"title": "Defining custom patterns for secret scanning"
} |
This article shows how you can enable extended metadata checks for individual repositories through repository settings. Alternatively, you can enable them at scale using security configurations at the organization or enterprise level. See AUTOTITLE or AUTOTITLE.
Prerequisites
Before enabling metadata checks, you need ... | {
"source": "github-docs/code-security/how-tos/secure-your-secrets/customize-leak-detection/enable-metadata-checks.md",
"title": "Enabling extended metadata checks for your repository"
} |
You can enable validity checks for individual repositories through repository settings. Validity checks verify whether detected secrets are still active, helping you prioritize remediation efforts. For information about what validity checks are and how they work, see AUTOTITLE.
For a list of which secret patterns suppo... | {
"source": "github-docs/code-security/how-tos/secure-your-secrets/customize-leak-detection/enable-validity-checks.md",
"title": "Enabling validity checks for your repository"
} |
You may have a reason to commit a secret to a repository, such as when you want to provide a fake secret in documentation, or in an example application. In these scenarios, you can quickly dismiss the alert and document the reasons. However, there may be cases where you want to ignore a directory entirely to avoid crea... | {
"source": "github-docs/code-security/how-tos/secure-your-secrets/customize-leak-detection/exclude-folders-and-files.md",
"title": "Excluding folders and files from secret scanning"
} |
Generating a regular expression for a repository with AI
1. Under "", under "Custom patterns", click New pattern.
1. When you're ready to test your new custom pattern, to identify matches in the repository without creating alerts, click Save and dry run.
Generating a regular expression for an organization with AI
1. W... | {
"source": "github-docs/code-security/how-tos/secure-your-secrets/customize-leak-detection/generating-regular-expressions-for-custom-patterns-with-ai.md",
"title": "Generating regular expressions for custom patterns with AI"
} |
Custom patterns are user-defined patterns that you can use to identify secrets that are not detected by the default patterns supported by . For more information, see AUTOTITLE.
At the enterprise level, only the creator of a custom pattern can edit the pattern, and use it in a dry run. There are no similar restrictions ... | {
"source": "github-docs/code-security/how-tos/secure-your-secrets/customize-leak-detection/manage-custom-patterns.md",
"title": "Managing custom patterns"
} |
About enabling
can be enabled on any free public repository that you own.
can be enabled for any repository that is owned by an organization, and for repositories owned by user accounts when using with .
If you're an organization owner, you can enable for multiple repositories at a time using . For more informatio... | {
"source": "github-docs/code-security/how-tos/secure-your-secrets/detect-secret-leaks/enable-secret-scanning.md",
"title": "Enabling secret scanning for your repository"
} |
Enabling
You can enable in the security settings page of your repository or organization.
Enabling for your repository
1. Under "", to the right of "Scan for AI-detected secrets", click Enable.
Enabling for your organization
You must configure for your organization using a . You can then apply the to all (or se... | {
"source": "github-docs/code-security/how-tos/secure-your-secrets/detect-secret-leaks/enabling-secret-scanning-for-ai-detected-secrets.md",
"title": "Enabling generic secret detection for AI-detected secrets"
} |
Enabling scanning for generic patterns
You can enable scanning for generic patterns. Generic patterns correspond to secrets such as private keys.
For more information about generic patterns, see "AUTOTITLEAUTOTITLE."
Enabling detection of generic patterns for a repository
1. Under "", to the right of "Generic patterns... | {
"source": "github-docs/code-security/how-tos/secure-your-secrets/detect-secret-leaks/enabling-secret-scanning-for-generic-patterns.md",
"title": "Enabling secret scanning for generic patterns"
} |
Delegated bypass for push protection lets you define who can push commits containing secrets and adds an approval process for other contributors. See AUTOTITLE.
To enable delegated bypass, create the teams or roles that will manage bypass requests. Alternatively, use fine-grained permissions for more granular control. ... | {
"source": "github-docs/code-security/how-tos/secure-your-secrets/manage-bypass-requests/enable-delegated-bypass.md",
"title": "Enabling delegated bypass for push protection"
} |
Granting exemptions for your repository
Granting exemptions for your organization
[!NOTE]
You can't add secret teams to the bypass list.
1. Click Save configuration.
1. Apply the security configuration to repositories in your organization. See AUTOTITLE.
Granting exemptions for your enterprise
1. Click Save ... | {
"source": "github-docs/code-security/how-tos/secure-your-secrets/manage-bypass-requests/grant-exemptions.md",
"title": "Exempting trusted actors from push protection"
} |
When delegated bypass for push protection is enabled, designated reviewers can approve or deny requests from contributors who want to push commits containing secrets.
This article explains how to review and manage bypass requests for repositories and organizations.
For more information about how bypass requests work, s... | {
"source": "github-docs/code-security/how-tos/secure-your-secrets/manage-bypass-requests/manage-bypass-requests.md",
"title": "Managing requests to bypass push protection"
} |
Prerequisites
Before you can review bypass requests, delegated bypass must be enabled for your organization or repositories. See AUTOTITLE.
You can review and manage these requests in security overview.
Reviewing bypass requests for an organization
1. In the sidebar, under "Requests", click Push protection bypass.
1.... | {
"source": "github-docs/code-security/how-tos/secure-your-secrets/manage-bypass-requests/review-bypass-requests.md",
"title": "Reviewing requests to bypass push protection"
} |
1. If you have not already enabled , to the right of "", click Enable.
1. In the "" section, to the right of "Push protection", click Enable. | {
"source": "github-docs/code-security/how-tos/secure-your-secrets/prevent-future-leaks/enable-push-protection.md",
"title": "Enabling push protection for your repository"
} |
1. Under "User", to the right of "Push protection for yourself", update your settings.
!Screenshot of the "User" section of the "Code security and analysis" settings page. A button labeled "Disable" is outlined in dark orange. | {
"source": "github-docs/code-security/how-tos/secure-your-secrets/prevent-future-leaks/manage-user-push-protection.md",
"title": "Managing push protection for users"
} |
About push protection in the UI
When you upload, create, or edit files from the UI, push protection prevents you from accidentally committing secrets to a repository by blocking commits containing supported secrets.
will also block the commit if you attempt to upload files containing supported secrets.
You should ei... | {
"source": "github-docs/code-security/how-tos/secure-your-secrets/work-with-leak-prevention/push-protection-in-the-github-ui.md",
"title": "Working with push protection in the GitHub UI"
} |
Resolving a blocked push
To resolve a blocked push, you must remove the secret from all of the commits it appears in.
If the secret was introduced by your latest commit, see Removing a secret introduced by the latest commit on your branch.
If the secret appears in earlier commits, see Removing a secret introduced by ... | {
"source": "github-docs/code-security/how-tos/secure-your-secrets/work-with-leak-prevention/push-protection-on-the-command-line.md",
"title": "Working with push protection from the command line"
} |
You can export the current state of the dependency graph for your repository as a software bill of materials (SBOM) using the industry standard SPDX format.
SBOMs include an inventory of a project's dependencies and associated information such as versions and package identifiersversions, package identifiers, licenses, ... | {
"source": "github-docs/code-security/how-tos/secure-your-supply-chain/establish-provenance-and-integrity/export-dependencies-as-sbom.md",
"title": "Exporting a software bill of materials for your repository"
} |
Enforcing immutable releases for your repository
1. Scroll down to the "Releases" section, then select Enable release immutability. Be aware that immutability will only apply to future releases.
Enforcing immutable releases for your organization
1. select the Repository dropdown menu, then click General.
1. In the "... | {
"source": "github-docs/code-security/how-tos/secure-your-supply-chain/establish-provenance-and-integrity/prevent-release-changes.md",
"title": "Preventing changes to your releases"
} |
It is not possible to delete an artifact from the . However, if an artifact has been removed from your organization's registry or is no longer deployed anywhere, you can update an artifact's storage or deployment record to reflect its status.
Updating a storage record
When you delete an artifact from your external reg... | {
"source": "github-docs/code-security/how-tos/secure-your-supply-chain/establish-provenance-and-integrity/remove-linked-artifacts.md",
"title": "Removing artifacts from the {% data variables.product.virtual_registry %}"
} |
The includes storage records and deployment records for artifacts that you build in your organization. Metadata for each artifact is provided by your organization using one of the following methods:
A workflow containing one of 's actions for artifact attestations
An integration with Dynatrace, JFrog Artifactory, or... | {
"source": "github-docs/code-security/how-tos/secure-your-supply-chain/establish-provenance-and-integrity/upload-linked-artifacts.md",
"title": "Uploading storage and deployment data to the {% data variables.product.virtual_registry %}"
} |
You can use the to connect your organization's artifacts to their build details, deployment context, and security metadata. The collects metadata for artifacts built with in your organization's repositories, regardless of whether the artifacts are stored on . For more information, see AUTOTITLE.
Viewing an artifact... | {
"source": "github-docs/code-security/how-tos/secure-your-supply-chain/establish-provenance-and-integrity/view-linked-artifacts.md",
"title": "Auditing your organization's builds on the {% data variables.product.virtual_registry %}"
} |
---
title: Securing your supply chain
shortTitle: Secure your supply chain
intro: Enable and manage features for supply chain security.
versions:
fpt: ''
ghes: ''
ghec: ''
contentType: how-tos
redirectfrom:
- /categories/managing-security-vulnerabilities
- /github/managing-security-vulnerabilities
- /code-s... | {
"source": "github-docs/code-security/how-tos/secure-your-supply-chain/index.md",
"title": ""
} |
About
You can create your own based on alert metadata. You can choose to auto-dismiss alerts indefinitely, or snooze alerts until a patch becomes available, and you can specify which you want to open pull requests for. Rules are applied before alert notifications are sent, so creating custom rules that auto-dismiss... | {
"source": "github-docs/code-security/how-tos/secure-your-supply-chain/manage-your-dependency-security/auto-triage-dependabot-alerts.md",
"title": "Customizing auto-triage rules to prioritize Dependabot alerts"
} |
About private registries
keeps your dependencies up-to-date and updates vulnerable dependencies. can access public registries. In addition, you can give access to private package registries and private repositories so that you can keep your private and innersource dependencies as up-to-date and secure as your publ... | {
"source": "github-docs/code-security/how-tos/secure-your-supply-chain/manage-your-dependency-security/configure-access-to-private-registries.md",
"title": "Configuring access to private registries for Dependabot"
} |
Google Cloud Artifact Registry requires the values url and
workload-identity-provider. The values service-account and audience are
optional:
registries:
my-gcp-artifact-registry:
type: docker-registry
url: https://REGION-docker.pkg.dev
workload-identity-provider: projects/PROJECT-NUMBER/locations/global/w... | {
"source": "github-docs/code-security/how-tos/secure-your-supply-chain/manage-your-dependency-security/configure-access-to-private-registries.md",
"title": "Configuring access to private registries for Dependabot"
} |
By default, sends notifications about new alerts by email to people with write, maintain, or admin permissions to a repository. See AUTOTITLE.
Configuring notifications for
You can configure notification settings for yourself or your organization from the Manage notifications drop-down shown at the top of each page... | {
"source": "github-docs/code-security/how-tos/secure-your-supply-chain/manage-your-dependency-security/configure-dependabot-notifications.md",
"title": "Configuring notifications for Dependabot alerts"
} |
The "" refers to the specific action that can report on differences in a pull request within the context. It can also add enforcement mechanisms to the workflow. For more information, see AUTOTITLE.
[!NOTE]
For a list of common configuration options, see Dependency review on the .
Configuring the
There are two met... | {
"source": "github-docs/code-security/how-tos/secure-your-supply-chain/manage-your-dependency-security/configure-dependency-review-action.md",
"title": "Configuring the dependency review action"
} |
Prerequisites
Before you configure license policies, ensure that:
Your organization has
You have access to manage enterprise policy and rulesets
Dependency graph is enabled for repositories you want to evaluate
About license compliance
Open source license compliance lets you define a policy that specifies which li... | {
"source": "github-docs/code-security/how-tos/secure-your-supply-chain/manage-your-dependency-security/configure-license-policies.md",
"title": "Configuring open source license policies"
} |
Enabling or disabling on standard -hosted runners
You can configure on standard -hosted runners:
For your repository
For your organization
If you restrict access to your organization's or repository's private resources, you may need to update your list of allowed IP addresses prior to enabling on runners. You can... | {
"source": "github-docs/code-security/how-tos/secure-your-supply-chain/manage-your-dependency-security/configure-on-github-hosted-runners.md",
"title": "Configuring Dependabot on GitHub-hosted runners"
} |
Prerequisites
is installed and enabled.
is enabled and in use.
Adding self-hosted runners for updates
1. Provision self-hosted runners, at the repository or organization level. For more information, see AUTOTITLE and AUTOTITLE.
1. Configure your environment and runners to meet the requirements for . See Requireme... | {
"source": "github-docs/code-security/how-tos/secure-your-supply-chain/manage-your-dependency-security/configure-on-self-hosted-runners.md",
"title": "Configuring Dependabot on self-hosted runners"
} |
This article contains recommendations and advice to help you configure to access your private registry, along with:
Detailed snippets of the dependabot.yml configuration file for each package manager
Important limitations or caveats
Steps explaining how to test that the configuration is working
Extra configuration... | {
"source": "github-docs/code-security/how-tos/secure-your-supply-chain/manage-your-dependency-security/configure-private-registries.md",
"title": "Guidance for the configuration of private registries for Dependabot"
} |
You can customize your configuration to suit your needs, by adding options to your dependabot.yml file. For example, you can make sure that uses the correct package manifest files, and updates only the dependencies you want maintained.
This article collates customization options you may find useful.
Defining multipl... | {
"source": "github-docs/code-security/how-tos/secure-your-supply-chain/manage-your-dependency-security/controlling-dependencies-updated.md",
"title": "Controlling which dependencies are updated by Dependabot"
} |
Preparing to customize pull requests
If you haven't yet configured a dependabot.yml file for your repository and you want to customize pull requests for security updates, you must first:
1. Check in a dependabot.yml file into the .github directory of your repository. For more information, see AUTOTITLE.
1. Set all the ... | {
"source": "github-docs/code-security/how-tos/secure-your-supply-chain/manage-your-dependency-security/customizing-dependabot-security-prs.md",
"title": "Customizing pull requests for Dependabot security updates"
} |
Viewing dependencies monitored by
After you've enabled version updates, you can confirm that your configuration is correct using the tab in the dependency graph for the repository. For more information, see AUTOTITLE.
1. Optionally, to view the files monitored for a package manager, to the right of the package manage... | {
"source": "github-docs/code-security/how-tos/secure-your-supply-chain/manage-your-dependency-security/list-configured-dependencies.md",
"title": "Listing dependencies configured for version updates"
} |
Viewing pull requests
1. Any pull requests for security or version updates are easy to identify.
The author is dependabotdependabot, the bot account used by .
By default, they have the dependencies label.
Changing the rebase strategy for pull requests
By default, automatically rebases pull requests to res... | {
"source": "github-docs/code-security/how-tos/secure-your-supply-chain/manage-your-dependency-security/manage-dependabot-prs.md",
"title": "Managing pull requests for dependency updates"
} |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.