forked from github/docs
-
Notifications
You must be signed in to change notification settings - Fork 2
/
code-security.yml
221 lines (221 loc) · 11.4 KB
/
code-security.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
security_advisories:
title: Fix and disclose a security vulnerability
description: >-
Using repository security advisories to privately fix a reported
vulnerability and get a CVE.
guides:
- >-
/code-security/security-advisories/guidance-on-reporting-and-writing-information-about-vulnerabilities/about-coordinated-disclosure-of-security-vulnerabilities
- >-
/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-the-github-advisory-database
- >-
/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-global-security-advisories
- >-
/code-security/security-advisories/working-with-repository-security-advisories/about-repository-security-advisories
- >-
/code-security/security-advisories/guidance-on-reporting-and-writing-information-about-vulnerabilities/best-practices-for-writing-repository-security-advisories
- >-
/code-security/security-advisories/guidance-on-reporting-and-writing-information-about-vulnerabilities/privately-reporting-a-security-vulnerability
- >-
/code-security/security-advisories/guidance-on-reporting-and-writing-information-about-vulnerabilities/managing-privately-reported-security-vulnerabilities
- >-
/code-security/security-advisories/working-with-repository-security-advisories/configuring-private-vulnerability-reporting-for-a-repository
- >-
/code-security/security-advisories/working-with-repository-security-advisories/configuring-private-vulnerability-reporting-for-an-organization
- >-
/code-security/security-advisories/working-with-repository-security-advisories/creating-a-repository-security-advisory
- >-
/code-security/security-advisories/working-with-repository-security-advisories/adding-a-collaborator-to-a-repository-security-advisory
- >-
/code-security/security-advisories/working-with-repository-security-advisories/collaborating-in-a-temporary-private-fork-to-resolve-a-repository-security-vulnerability
- >-
/code-security/security-advisories/working-with-repository-security-advisories/publishing-a-repository-security-advisory
- >-
/code-security/security-advisories/working-with-repository-security-advisories/editing-a-repository-security-advisory
- >-
/code-security/security-advisories/working-with-repository-security-advisories/deleting-a-repository-security-advisory
- >-
/code-security/security-advisories/working-with-repository-security-advisories/removing-a-collaborator-from-a-repository-security-advisory
dependabot_alerts:
title: Get notifications for insecure dependencies
description: >-
Set up Dependabot to alert you to new vulnerabilities{% ifversion
GH-advisory-db-supports-malware %} or malware{% endif %} in your
dependencies.
guides:
- /code-security/dependabot/dependabot-alerts/about-dependabot-alerts
- >-
/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository
- >-
/code-security/dependabot/dependabot-alerts/viewing-and-updating-dependabot-alerts
- >-
/code-security/dependabot/dependabot-auto-triage-rules/about-dependabot-auto-triage-rules
- >-
/code-security/dependabot/dependabot-alerts/configuring-notifications-for-dependabot-alerts
- >-
/code-security/dependabot/working-with-dependabot/managing-pull-requests-for-dependency-updates
- >-
/code-security/dependabot/working-with-dependabot/troubleshooting-the-detection-of-vulnerable-dependencies
- >-
/code-security/dependabot/working-with-dependabot/troubleshooting-dependabot-errors
dependabot_security_updates:
title: Get pull requests to update your vulnerable dependencies
description: >-
Set up Dependabot to create pull requests when new vulnerabilities are
reported.
guides:
- >-
/code-security/dependabot/dependabot-security-updates/about-dependabot-security-updates
- >-
/code-security/dependabot/dependabot-security-updates/configuring-dependabot-security-updates
- >-
/code-security/dependabot/dependabot-alerts/configuring-notifications-for-dependabot-alerts
- >-
/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository
- >-
/code-security/dependabot/working-with-dependabot/managing-pull-requests-for-dependency-updates
- >-
/code-security/dependabot/working-with-dependabot/troubleshooting-the-detection-of-vulnerable-dependencies
dependency_version_updates:
title: Keep your dependencies up-to-date
description: >-
Use Dependabot to check for new releases and create pull requests to update
your dependencies.
guides:
- >-
/code-security/dependabot/dependabot-version-updates/about-dependabot-version-updates
- >-
/code-security/dependabot/dependabot-version-updates/configuring-dependabot-version-updates
- >-
/code-security/dependabot/dependabot-version-updates/customizing-dependency-updates
- >-
/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file
- >-
/code-security/dependabot/working-with-dependabot/keeping-your-actions-up-to-date-with-dependabot
- >-
/code-security/dependabot/working-with-dependabot/automating-dependabot-with-github-actions
- >-
/code-security/dependabot/dependabot-version-updates/listing-dependencies-configured-for-version-updates
- >-
/code-security/dependabot/working-with-dependabot/configuring-access-to-private-registries-for-dependabot
- >-
/code-security/dependabot/working-with-dependabot/guidance-for-the-configuration-of-private-registries-for-dependabot
- >-
/code-security/dependabot/working-with-dependabot/removing-dependabot-access-to-public-registries
- >-
/code-security/dependabot/working-with-dependabot/managing-pull-requests-for-dependency-updates
- >-
/code-security/dependabot/working-with-dependabot/troubleshooting-dependabot-errors
secret_scanning:
title: Scan for secrets
description: >-
Set up secret scanning to guard against accidental check-ins of tokens,
passwords, and other secrets to your repository.
guides:
- /code-security/secret-scanning/introduction/about-secret-scanning
- /code-security/secret-scanning/enabling-secret-scanning-features/enabling-secret-scanning-for-your-repository
- /code-security/secret-scanning/enabling-secret-scanning-features/enabling-push-protection-for-your-repository
- >-
{% ifversion secret-scanning-validity-check-partner-patterns %}
/code-security/secret-scanning/enabling-secret-scanning-features/enabling-validity-checks-for-your-repository{% endif %}
- >-
{% ifversion not fpt
%}/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/custom-patterns/defining-custom-patterns-for-secret-scanning{%
endif %}
- /code-security/secret-scanning/managing-alerts-from-secret-scanning
- /code-security/secret-scanning/introduction/supported-secret-scanning-patterns
- >-
{% ifversion secret-scanning-push-protection
%}/code-security/secret-scanning/introduction/about-push-protection{%
endif %}
- >-
{% ifversion secret-scanning-push-protection-for-users
%}/code-security/secret-scanning/working-with-secret-scanning-and-push-protection/push-protection-for-users{%
endif %}
- >-
{% ifversion secret-scanning-push-protection
%}/code-security/secret-scanning/working-with-secret-scanning-and-push-protection/working-with-push-protection-from-the-command-line{%
endif %}
- >-
{% ifversion secret-scanning-push-protection
%}/code-security/secret-scanning/working-with-secret-scanning-and-push-protection/working-with-push-protection-in-the-github-ui{%
endif %}
- >-
/code-security/secret-scanning/troubleshooting-secret-scanning-and-push-protection/troubleshooting-secret-scanning
security_alerts:
title: Explore and manage security alerts
description: Learn where to find and resolve security alerts.
guides:
- >-
{% ifversion ghec or ghes
%}/code-security/security-overview/about-security-overview {% endif %}
- >-
{% ifversion ghec or ghes
%}/code-security/security-overview/assessing-adoption-code-security {%
endif %}
- >-
{% ifversion ghec or ghes
%}/code-security/security-overview/assessing-code-security-risk {% endif
%}
- >-
{% ifversion ghec or ghes
%}/code-security/secret-scanning/managing-alerts-from-secret-scanning {%
endif %}
- >-
{% ifversion ghec or ghes
%}/code-security/code-scanning/managing-code-scanning-alerts/managing-code-scanning-alerts-for-your-repository{%
endif %}
- >-
{% ifversion ghec or ghes
%}/code-security/code-scanning/managing-code-scanning-alerts/triaging-code-scanning-alerts-in-pull-requests{%
endif %}
- >-
{% ifversion ghec or ghes
%}/code-security/dependabot/dependabot-alerts/viewing-and-updating-dependabot-alerts{%
endif %}
- >-
{% ifversion ghec or ghes
%}/code-security/getting-started/auditing-security-alerts {% endif %}
code_security_actions:
title: Run code scanning with GitHub Actions
description: >-
Check your default branch and every pull request to keep vulnerabilities and
errors out of your repository.
guides:
- >-
/code-security/code-scanning/introduction-to-code-scanning/about-code-scanning
- >-
/code-security/code-scanning/enabling-code-scanning/configuring-default-setup-for-code-scanning
- >-
/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/customizing-your-advanced-setup-for-code-scanning
- >-
/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/codeql-code-scanning-for-compiled-languages
- >-
/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/running-codeql-code-scanning-in-a-container
- /code-security/code-scanning/troubleshooting-code-scanning
- >-
/code-security/code-scanning/managing-your-code-scanning-configuration/about-the-tool-status-page
code_security_integration:
title: Integrate with code scanning
description: Upload code analysis results from third-party systems to GitHub using SARIF.
guides:
- >-
/code-security/code-scanning/integrating-with-code-scanning/about-integration-with-code-scanning
- >-
/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github
- >-
/code-security/code-scanning/integrating-with-code-scanning/sarif-support-for-code-scanning
- /rest/code-scanning
end_to_end_supply_chain:
title: End-to-end supply chain
description: >-
How to think about securing your user accounts, your code, and your build
process.
guides:
- >-
/code-security/supply-chain-security/end-to-end-supply-chain/end-to-end-supply-chain-overview
- >-
/code-security/supply-chain-security/end-to-end-supply-chain/securing-accounts
- /code-security/supply-chain-security/end-to-end-supply-chain/securing-code
- >-
/code-security/supply-chain-security/end-to-end-supply-chain/securing-builds