Skip to content

Commit b06dbb6

Browse files
authored
[EDI] Create a brief conceptual article on GitHub secrets (#59240)
1 parent 893da02 commit b06dbb6

File tree

3 files changed

+32
-16
lines changed

3 files changed

+32
-16
lines changed
Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
---
2+
title: GitHub secret types
3+
intro: Learn about the different types of secrets used by {% data variables.product.github %}.
4+
versions:
5+
fpt: '*'
6+
ghes: '*'
7+
ghec: '*'
8+
topics:
9+
- Secret scanning
10+
- Secret Protection
11+
- Dependabot
12+
- Actions
13+
- Codespaces
14+
contentType: concepts
15+
---
16+
17+
{% data variables.product.github %} secrets are used to securely store sensitive information like API keys, tokens, and passwords in repositories.
18+
19+
When you store the sensitive information as a {% data variables.product.github %} secret, you remove the need to hardcode the credential or key, and prevent exposure of it in your code or logs. The secret can then be used to authenticate services, manage credentials, and securely pass sensitive data in workflows.
20+
21+
There are {% ifversion fpt or ghec %}three {% else %}two {% endif %}types of secrets used by {% data variables.product.github %}:
22+
23+
* {% data variables.product.prodname_dependabot %} secrets
24+
* Actions secrets{% ifversion fpt or ghec %}
25+
* {% data variables.product.prodname_codespaces %} secrets{% endif %}
26+
27+
Depending on the {% data variables.product.github %} secret type, you can create and manage secrets under your repository, organization, or personal account security settings page.
28+
29+
For information on the usage, scope, permissions, and limitations of each secret type, see [AUTOTITLE](/code-security/reference/secret-security/understanding-github-secret-types).

content/code-security/concepts/secret-security/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ children:
1717
- /about-alerts
1818
- /about-delegated-bypass-for-push-protection
1919
- /about-secret-scanning-for-partners
20+
- /github-secret-types
2021
- /working-with-push-protection-and-the-github-mcp-server
2122
- /working-with-push-protection-from-the-rest-api
2223
redirect_from:

content/code-security/reference/secret-security/understanding-github-secret-types.md

Lines changed: 2 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -16,25 +16,11 @@ redirect_from:
1616
contentType: reference
1717
---
1818

19-
## About {% data variables.product.github %}'s secret types
20-
21-
{% data variables.product.github %} secrets are used to securely store sensitive information like API keys, tokens, and passwords in repositories.
22-
23-
When you store the sensitive information as a {% data variables.product.github %} secret, you remove the need to hardcode the credential or key, and prevent exposure of it in your code or logs. The secret can then be used to authenticate services, manage credentials, and securely pass sensitive data in workflows.
24-
25-
There are {% ifversion fpt or ghec %}three {% else %}two {% endif %}types of secrets used by {% data variables.product.github %}:
26-
27-
* [{% data variables.product.prodname_dependabot %} secrets](#dependabot-secrets)
28-
* [Actions secrets](#actions-secrets){% ifversion fpt or ghec %}
29-
* [{% data variables.product.prodname_codespaces %} secrets](#codespaces-secrets){% endif %}
30-
31-
Depending on the {% data variables.product.github %} secret type, you can create and manage secrets under your repository, organization, or personal account security settings page.
32-
3319
{% ifversion fpt or ghec %}
3420

35-
### Understanding how {% data variables.product.github %} stores secrets
21+
## How {% data variables.product.github %} stores secrets
3622

37-
{% data variables.product.github %} uses [Libsodium sealed boxes](https://libsodium.gitbook.io/doc/public-key_cryptography/sealed_boxes) to encrypt secrets. A secret is encrypted before reaching {% data variables.product.github %} and remains encrypted until it's used by the relevant service ({% data variables.product.prodname_dependabot %}, {% data variables.product.prodname_actions %}, or {% data variables.product.prodname_codespaces %}).
23+
{% data variables.product.github %} uses [Libsodium sealed boxes](https://libsodium.gitbook.io/doc/public-key_cryptography/sealed_boxes) to encrypt secrets. A secret is encrypted before reaching {% data variables.product.github %} and remains encrypted until it's used by {% data variables.product.prodname_dependabot %}, {% data variables.product.prodname_actions %}, or {% data variables.product.prodname_codespaces %}.
3824

3925
{% endif %}
4026

0 commit comments

Comments
 (0)