Skip to content
Closed
Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
82 commits
Select commit Hold shift + click to select a range
2d2b121
document new notification behavior
mchammer01 Feb 1, 2021
25ef40b
tidy up
mchammer01 Feb 1, 2021
2dc3839
fix inline formatting
mchammer01 Feb 1, 2021
b674598
Apply suggestions from code review
mchammer01 Feb 2, 2021
5109b56
Merge branch 'main' into 3634-dependabot-combined-notification
mchammer01 Feb 2, 2021
cf1a0e7
Merge branch 'main' into 3634-dependabot-combined-notification
mchammer01 Feb 11, 2021
36bf562
Merge branch 'main' into 3634-dependabot-combined-notification
mchammer01 Feb 18, 2021
2177ad1
Merge branch 'main' into 3634-dependabot-combined-notification
mchammer01 Feb 22, 2021
c1f20bc
fix incorrect Liquid versioning
mchammer01 Feb 22, 2021
8ab785e
Merge branch 'main' into 3634-dependabot-combined-notification
mchammer01 Feb 22, 2021
85c2faa
repo sync
Octomerger Mar 15, 2021
d25ee7d
add content about workflow availability
mchammer01 Mar 15, 2021
537ad75
reword
mchammer01 Mar 15, 2021
ba7db08
apply versioning
mchammer01 Mar 15, 2021
7b05542
fix ordered list formatting
mchammer01 Mar 15, 2021
e2bf0fd
address review comment
mchammer01 Mar 15, 2021
4d124dc
Preview for slash command early access doc updates (#18232)
Mar 15, 2021
522728f
Branch was updated using the 'autoupdate branch' Actions workflow.
Octomerger Mar 15, 2021
edd7500
repo sync
Octomerger Mar 15, 2021
83f1e3a
[SEO] Correct footer links (#18136)
skullface Mar 15, 2021
9eccffe
[March 15] Dependabot version updates support for private registries …
hubwriter Mar 15, 2021
beef176
empty commit for preview (#18256)
Mar 15, 2021
c535420
decorate script fix (#18201)
rachmari Mar 16, 2021
5994a4f
add 2.21.16 release notes
bwestover Mar 16, 2021
11af364
add 2.22.8 release notes
bwestover Mar 16, 2021
3051487
add 3.0.2 release notes
bwestover Mar 16, 2021
9b58c6d
try adding back quotes
bwestover Mar 16, 2021
b1f4b29
Revert "try adding back quotes"
bwestover Mar 16, 2021
3a7cb3b
space_invader
bwestover Mar 16, 2021
149addd
Merge branch 'main' of github.com:github/docs-internal into patch-rel…
bwestover Mar 16, 2021
b45ace3
encode a colon
bwestover Mar 16, 2021
2bf7faf
Update data/release-notes/3-0/2.yml
bwestover Mar 16, 2021
f7f3e11
update versioning
mchammer01 Mar 16, 2021
1e0ff90
Merge branch 'main' into 3634-dependabot-combined-notification
mchammer01 Mar 16, 2021
42c894f
Merge branch '3634-dependabot-combined-notification' of github.com:gi…
mchammer01 Mar 16, 2021
9ebe58a
Merge branch '3634-dependabot-combined-notification' of github.com:gi…
mchammer01 Mar 16, 2021
ff2f58a
yet more versioning updates
mchammer01 Mar 16, 2021
6f3f214
Update github-sponsors-additional-terms.md (#17937)
Mar 16, 2021
b304674
Merge branch 'main' into patch-release-notes-2021-03-16
sarahs Mar 16, 2021
f425ada
Merge pull request #18258 from github/patch-release-notes-2021-03-16
sarahs Mar 16, 2021
fc38a40
check for openapi type property (#18257)
rachmari Mar 16, 2021
8f63a44
Update OpenAPI Descriptions (#18249)
github-openapi-bot Mar 16, 2021
0240147
Group user docs on code security into a new "product" (#18196)
felicitymay Mar 16, 2021
8d757ee
Move team discussions content to orgs category (#18217)
emilyistoofunky Mar 16, 2021
60bd45b
Merge branch 'main' into repo-sync
rachmari Mar 16, 2021
fecda83
repo sync
Octomerger Mar 16, 2021
a34dcc4
Actions for Project Management (#17849)
Mar 16, 2021
c6f0298
Branch was updated using the 'autoupdate branch' Actions workflow.
Octomerger Mar 16, 2021
52aeeab
repo sync
Octomerger Mar 16, 2021
f2d8ccb
Add missing Audit Log events for GitHub Actions (#17616)
Mar 17, 2021
54ef0fd
[Ready to ship, March 16] New types of push notifications for GitHub …
ethanpalm Mar 17, 2021
b18d884
Adding additional information for workflow_runs (#18235)
asciimike Mar 17, 2021
ea6adac
Branch was updated using the 'autoupdate branch' Actions workflow.
Octomerger Mar 17, 2021
8b6dc9f
repo sync
Octomerger Mar 17, 2021
6a7e93f
Revert "Group user docs on code security into a new "product" (#18196…
felicitymay Mar 17, 2021
1bc1e84
Code scanning: uploading results as PR checks (#18050)
shati-patel Mar 17, 2021
fb5dec6
Clarify the availability of GHAS licenses for dotcom (#18246)
felicitymay Mar 17, 2021
cd2a217
do not error if frontmatter includes next GHES release or hardcoded next
sarahs Mar 17, 2021
5006cda
add tests
sarahs Mar 17, 2021
4aa879e
Update Packages support overview diagram (#18231)
jmarlena Mar 17, 2021
1d04403
rerun CI
sarahs Mar 17, 2021
56d8ebd
Merge branch 'main' into support-next-release-in-frontmatter
sarahs Mar 17, 2021
443d028
Merge pull request #18281 from github/support-next-release-in-frontma…
sarahs Mar 17, 2021
0192f59
[March 17] Remove all notes about ubuntu-latest migration and fix lab…
AlenaSviridenko Mar 17, 2021
b1b8cb8
add topic frontmatter to articles (#18245)
rachmari Mar 17, 2021
17f09e0
Add target completion date status commmand (#18286)
chiedo Mar 17, 2021
02ee72f
add topics attribute to search (#18212)
rachmari Mar 17, 2021
2e07070
Add filters params to search endpoint (#18289)
heiskr Mar 17, 2021
0c8bf6f
Branch was updated using the 'autoupdate branch' Actions workflow.
Octomerger Mar 17, 2021
7dc3c71
repo sync
Octomerger Mar 17, 2021
ddb0c20
Update search example with topics with white space (#18290)
rachmari Mar 17, 2021
7deb7a8
Merge branch 'main' into 3634-dependabot-combined-notification
mchammer01 Mar 18, 2021
55cbdbf
Update content/github/finding-security-vulnerabilities-and-errors-in-…
mchammer01 Mar 18, 2021
680ad2e
Merge branch 'main' into 3045-workflow-availability
mchammer01 Mar 18, 2021
3623ef0
Merge pull request #18253 from github/3045-workflow-availability
mchammer01 Mar 18, 2021
3d90904
Merge branch 'main' into 3634-dependabot-combined-notification
mchammer01 Mar 18, 2021
44cf73d
Add workflow to triage ready-for-doc-review PRs (#18226)
shati-patel Mar 18, 2021
fa42d8d
Adding enterprise release note for bug fix (#18265)
belaltaher8 Mar 18, 2021
6de2bf3
Add How We Work boards automation (#18298)
chiedo Mar 18, 2021
35fdf0d
Merge How We Work Workflows and Fix bugs (#18299)
chiedo Mar 18, 2021
c416d31
Merge branch 'main' into 3634-dependabot-combined-notification
mchammer01 Mar 18, 2021
31a9ea6
Merge pull request #17590 from github/3634-dependabot-combined-notifi…
mchammer01 Mar 18, 2021
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Group user docs on code security into a new "product" (#18196)
  • Loading branch information
felicitymay authored Mar 16, 2021
commit 024014740b49f602fc44a443506dec41d2d65858
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
title: About securing your repository
intro: '{% data variables.product.product_name %} provides a number of ways that you can help keep your repository secure.'
redirect_from:
- /github/administering-a-repository/about-securing-your-repository
versions:
free-pro-team: '*'
enterprise-server: '>=3.0'
Expand Down
13 changes: 13 additions & 0 deletions content/code-security/getting-started/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
title: Getting started with code security
shortTitle: Getting started
intro: 'Introduction to code security with {% data variables.product.product_name %}.'
versions:
free-pro-team: '*'
enterprise-server: '>=3.0'
github-ae: '*'
---

### Table of Contents

{% link_in_list /about-securing-your-repository %}
19 changes: 19 additions & 0 deletions content/code-security/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
title: Code security
shortTitle: Code security
intro: 'Learn how to keep the code stored in your repositories secure.'
versions:
free-pro-team: '*'
enterprise-server: '>=3.0'
github-ae: '*'
---

{% link_with_intro /getting-started %}

{% link_with_intro /secret-security %}

{% link_with_intro /secure-coding %}

{% link_with_intro /security-advisories %}

{% link_with_intro /supply-chain-security %}
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ redirect_from:
- /github/administering-a-repository/about-token-scanning
- /articles/about-token-scanning
- /articles/about-token-scanning-for-private-repositories
- /github/administering-a-repository/about-secret-scanning
versions:
free-pro-team: '*'
enterprise-server: '>=3.0'
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ intro: 'You can configure how {% data variables.product.prodname_dotcom %} scans
permissions: 'People with admin permissions to a repository can enable {% data variables.product.prodname_secret_scanning %} for the repository.'
redirect_from:
- /github/administering-a-repository/configuring-secret-scanning-for-private-repositories
- /github/administering-a-repository/configuring-secret-scanning-for-your-repositories
product: '{% data reusables.gated-features.secret-scanning %}'
versions:
free-pro-team: '*'
Expand Down
16 changes: 16 additions & 0 deletions content/code-security/secret-security/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
title: Keeping secrets secure
shortTitle: Secret security
intro: 'Let GitHub do the hard work of ensuring that tokens, private keys, and other code secrets are not exposed in your repository.'
product: '{% data reusables.gated-features.secret-scanning %}'
versions:
free-pro-team: '*'
enterprise-server: '>=3.0'
github-ae: '*'
---

### Table of Contents

{% link_in_list /about-secret-scanning %}
{% link_in_list /configuring-secret-scanning-for-your-repositories %}
{% link_in_list /managing-alerts-from-secret-scanning %}
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
title: Managing alerts from secret scanning
intro: You can view and close alerts for secrets checked in to your repository.
product: '{% data reusables.gated-features.secret-scanning %}'
redirect_from:
- /github/administering-a-repository/managing-alerts-from-secret-scanning
versions:
free-pro-team: '*'
enterprise-server: '>=3.0'
Expand Down
62 changes: 62 additions & 0 deletions content/code-security/secure-coding/about-code-scanning.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
---
title: About code scanning
intro: 'You can use {% data variables.product.prodname_code_scanning %} to find security vulnerabilities and errors in the code for your project on {% data variables.product.prodname_dotcom %}.'
product: '{% data reusables.gated-features.code-scanning %}'
redirect_from:
- /github/finding-security-vulnerabilities-and-errors-in-your-code/about-code-scanning
versions:
free-pro-team: '*'
enterprise-server: '>=3.0'
github-ae: '*'
---

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

### About {% data variables.product.prodname_code_scanning %}

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

You can use {% data variables.product.prodname_code_scanning %} to find, triage, and prioritize fixes for existing problems in your code. {% data variables.product.prodname_code_scanning_capc %} also prevents developers from introducing new problems. You can schedule scans for specific days and times, or trigger scans when a specific event occurs in the repository, such as a push.

If {% data variables.product.prodname_code_scanning %} finds a potential vulnerability or error in your code, {% data variables.product.prodname_dotcom %} displays an alert in the repository. After you fix the code that triggered the alert, {% data variables.product.prodname_dotcom %} closes the alert. For more information, see "[Managing {% data variables.product.prodname_code_scanning %} alerts for your repository](/code-security/secure-coding/managing-code-scanning-alerts-for-your-repository)."

To monitor results from {% data variables.product.prodname_code_scanning %} across your repositories or your organization, you can use webhooks and the {% data variables.product.prodname_code_scanning %} API. For information about the webhooks for {% data variables.product.prodname_code_scanning %}, see
"[Webhook events and payloads](/developers/webhooks-and-events/webhook-events-and-payloads#code_scanning_alert)." For information about API endpoints, see "[{% data variables.product.prodname_code_scanning_capc %}](/rest/reference/code-scanning)."

To get started with {% data variables.product.prodname_code_scanning %}, see "[Setting up {% data variables.product.prodname_code_scanning %} for a repository](/code-security/secure-coding/setting-up-code-scanning-for-a-repository)."

### About {% data variables.product.prodname_codeql %}

You can use {% data variables.product.prodname_code_scanning %} with {% data variables.product.prodname_codeql %}, a semantic code analysis engine. {% data variables.product.prodname_codeql %} treats code as data, allowing you to find potential vulnerabilities in your code with greater confidence than traditional static analyzers.

{% data variables.product.prodname_ql %} is the query language that powers {% data variables.product.prodname_codeql %}. {% data variables.product.prodname_ql %} is an object-oriented logic programming language. {% data variables.product.company_short %}, language experts, and security researchers create the queries used for {% data variables.product.prodname_code_scanning %}, and the queries are open source. The community maintains and updates the queries to improve analysis and reduce false positives. For more information, see [{% data variables.product.prodname_codeql %}](https://securitylab.github.com/tools/codeql) on the GitHub Security Lab website.

{% data variables.product.prodname_code_scanning_capc %} with {% data variables.product.prodname_codeql %} supports both compiled and interpreted languages, and can find vulnerabilities and errors in code that's written in the supported languages.

{% data reusables.code-scanning.supported-languages %}

You can view and contribute to the queries for {% data variables.product.prodname_code_scanning %} in the [`github/codeql`](https://github.com/github/codeql) repository. For more information, see [{% data variables.product.prodname_codeql %} queries](https://codeql.github.com/docs/writing-codeql-queries/codeql-queries/) in the {% data variables.product.prodname_codeql %} documentation.

{% if currentVersion == "free-pro-team@latest" %}

### About billing for {% data variables.product.prodname_code_scanning %}

{% data variables.product.prodname_code_scanning_capc %} uses {% data variables.product.prodname_actions %}, and each run of a {% data variables.product.prodname_code_scanning %} workflow consumes minutes for {% data variables.product.prodname_actions %}. For more information, see "[About billing for {% data variables.product.prodname_actions %}](/github/setting-up-and-managing-billing-and-payments-on-github/about-billing-for-github-actions)."

{% endif %}

### About third-party code scanning tools

{% data reusables.code-scanning.you-can-upload-third-party-analysis %}

{% data reusables.code-scanning.interoperable-with-tools-that-output-sarif %}

{% data reusables.code-scanning.get-started-uploading-third-party-data %}

### Further reading

{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "[email protected]" %}
- "[About securing your repository](/github/administering-a-repository/about-securing-your-repository)"{% endif %}
- [{% data variables.product.prodname_security %}](https://securitylab.github.com/)
- [OASIS Static Analysis Results Interchange Format (SARIF) TC](https://www.oasis-open.org/committees/tc_home.php?wg_abbrev=sarif) on the OASIS Committee website
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
---
title: About integration with code scanning
shortTitle: About integration
intro: 'You can perform {% data variables.product.prodname_code_scanning %} externally and then display the results in {% data variables.product.prodname_dotcom %}, or set up webhooks that listen to {% data variables.product.prodname_code_scanning %} activity in your repository.'
product: '{% data reusables.gated-features.code-scanning %}'
redirect_from:
- /github/finding-security-vulnerabilities-and-errors-in-your-code/about-integration-with-code-scanning
versions:
free-pro-team: '*'
enterprise-server: '>=3.0'
github-ae: '*'
---

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

As an alternative to running {% data variables.product.prodname_code_scanning %} within {% data variables.product.prodname_dotcom %}, you can perform analysis elsewhere and then upload the results. Alerts for {% data variables.product.prodname_code_scanning %} that you run externally are displayed in the same way as those for {% data variables.product.prodname_code_scanning %} that you run within {% data variables.product.prodname_dotcom %}. For more information, see "[Managing {% data variables.product.prodname_code_scanning %} alerts for your repository](/code-security/secure-coding/managing-code-scanning-alerts-for-your-repository)."

If you use a third-party static analysis tool that can produce results as Static Analysis Results Interchange Format (SARIF) 2.1.0 data, you can upload this to {% data variables.product.prodname_dotcom %}. For more information, see "[Uploading a SARIF file to GitHub](/code-security/secure-coding/uploading-a-sarif-file-to-github)."

### Integrations with webhooks

You can use {% data variables.product.prodname_code_scanning %} webhooks to build or set up integrations, such as [{% data variables.product.prodname_github_app %}s](/apps/building-github-apps/) or [{% data variables.product.prodname_oauth_app %}s](/apps/building-oauth-apps/), that subscribe to {% data variables.product.prodname_code_scanning %} events in your repository. For example, you could build an integration that creates an issue on {% data variables.product.product_name %} or sends you a Slack notification when a new {% data variables.product.prodname_code_scanning %} alert is added in your repository. For more information, see "[Creating webhooks](/developers/webhooks-and-events/creating-webhooks)" and "[Webhook events and payloads](/developers/webhooks-and-events/webhook-events-and-payloads#code_scanning_alert)."

### Further reading

* "[About {% data variables.product.prodname_code_scanning %}](/code-security/secure-coding/about-code-scanning)"
* "[Using {% data variables.product.prodname_codeql %} {% data variables.product.prodname_code_scanning %} with your existing CI system](/code-security/secure-coding/using-codeql-code-scanning-with-your-existing-ci-system)"
* "[SARIF support for {% data variables.product.prodname_code_scanning %}](/code-security/secure-coding/sarif-support-for-code-scanning)"
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
title: Automatically scanning your code for vulnerabilities and errors
shortTitle: Scanning automatically
intro: 'You can find vulnerabilities and errors in your project''s code on {% data variables.product.prodname_dotcom %}, as well as view, triage, understand, and resolve the related {% data variables.product.prodname_code_scanning %} alerts.'
mapTopic: true
product: '{% data reusables.gated-features.code-scanning %}'
redirect_from:
- /github/finding-security-vulnerabilities-and-errors-in-your-code/automatically-scanning-your-code-for-vulnerabilities-and-errors
versions:
free-pro-team: '*'
enterprise-server: '>=3.0'
github-ae: '*'
---

Loading