Skip to content

Commit b99198c

Browse files
authored
Merge pull request #25751 from github/repo-sync
repo sync
2 parents 826ceb2 + cb390d7 commit b99198c

31 files changed

+121
-49
lines changed
173 KB
Loading
193 KB
Loading

content/apps/creating-github-apps/authenticating-with-a-github-app/about-authentication-with-a-github-app.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ versions:
88
ghec: '*'
99
topics:
1010
- GitHub Apps
11-
shortTitle: Authentication overview
11+
shortTitle: About authentication
1212
redirect_from:
1313
- /apps/building-integrations/setting-up-and-registering-github-apps/about-authentication-options-for-github-apps
1414
- /apps/building-github-apps/authentication-options-for-github-apps

content/apps/creating-github-apps/guides/index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,12 +13,12 @@ topics:
1313
- GitHub Apps
1414
children:
1515
- /quickstart
16-
- /setting-up-your-development-environment-to-create-a-github-app
1716
- /building-a-github-app-that-responds-to-webhook-events
1817
- /building-a-login-with-github-button-with-a-github-app
1918
- /building-a-cli-with-a-github-app
20-
- /using-the-github-api-in-your-app
2119
- /making-authenticated-api-requests-with-a-github-app-in-a-github-actions-workflow
20+
- /setting-up-your-development-environment-to-create-a-github-app
21+
- /using-the-github-api-in-your-app
2222
- /creating-ci-tests-with-the-checks-api
23-
- /migrating-oauth-apps-to-github-apps
2423
---
24+

content/apps/creating-github-apps/setting-up-a-github-app/about-creating-github-apps.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,10 @@ When building an integration, you should consider using a {% data variables.prod
5353

5454
In general, {% data variables.product.prodname_github_app %}s are preferred over {% data variables.product.prodname_oauth_app %}s.
5555

56+
Both {% data variables.product.prodname_oauth_app %}s and {% data variables.product.prodname_github_app %}s use OAuth 2.0.
57+
58+
{% data variables.product.prodname_oauth_app %}s can only act on behalf of a user while {% data variables.product.prodname_github_app %}s can either act on behalf of a user or independently of a user.
59+
5660
For more information, see "[AUTOTITLE](/apps/oauth-apps/building-oauth-apps/differences-between-github-apps-and-oauth-apps)."
5761

5862
For information on how to migrate an existing {% data variables.product.prodname_oauth_app %} to a {% data variables.product.prodname_github_app %}, see "[AUTOTITLE](/apps/creating-github-apps/guides/migrating-oauth-apps-to-github-apps)."

content/apps/creating-github-apps/setting-up-a-github-app/about-the-user-authorization-callback-url.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ redirect_from:
1515

1616
When you create a {% data variables.product.prodname_github_app %}, you can specify a callback URL. When you use the web application flow to generate a user access token in order to act on behalf of a user, users will be redirected to the callback URL after they authorize the app.
1717

18-
You can specify up to 10 callback URLs. If you specify multiple callback URLs, you can use the `redirect_uri` parameter when you prompt the user to authorize your app, to indicate which callback URL the user should be redirected to. If you do not specify `redirect_uri`, the first callback URL will be used.
18+
You can specify up to 10 callback URLs. If you specify multiple callback URLs, you can use the `redirect_uri` parameter when you prompt the user to authorize your app, to indicate which callback URL the user should be redirected to. If you do not specify `redirect_uri`, the first callback URL will be used. For more information about using the `redirect_uri` parameter, see "[AUTOTITLE](/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app)".
1919

2020
The callback URL is different from the setup URL. Users are redirected to the setup URL after they install an app. Users are redirected to the callback URL when they authorize an app via the web application flow. For more information, see "[AUTOTITLE](/apps/creating-github-apps/setting-up-a-github-app/about-the-setup-url)."
2121

content/apps/creating-github-apps/setting-up-a-github-app/creating-a-github-app.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
title: Creating a GitHub App
3+
shortTitle: Create a {% data variables.product.prodname_github_app %}
34
intro: 'You can create a {% data variables.product.prodname_github_app %} under your personal account or under any organization you own.'
45
redirect_from:
56
- /early-access/integrations/creating-an-integration

content/apps/creating-github-apps/setting-up-a-github-app/index.md

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -13,17 +13,15 @@ topics:
1313
- GitHub Apps
1414
children:
1515
- /about-creating-github-apps
16-
- /rate-limits-for-github-apps
16+
- /migrating-oauth-apps-to-github-apps
17+
- /best-practices-for-creating-a-github-app
1718
- /creating-a-github-app
19+
- /about-the-user-authorization-callback-url
20+
- /about-the-setup-url
1821
- /choosing-permissions-for-a-github-app
1922
- /using-webhooks-with-github-apps
2023
- /making-a-github-app-public-or-private
21-
- /making-your-github-app-available-for-github-enterprise-server
22-
- /creating-a-github-app-from-a-manifest
23-
- /creating-a-github-app-using-url-parameters
24+
- /rate-limits-for-github-apps
2425
- /creating-a-custom-badge-for-your-github-app
25-
- /about-the-user-authorization-callback-url
26-
- /about-the-setup-url
27-
- /best-practices-for-creating-a-github-app
2826
---
2927

content/apps/creating-github-apps/setting-up-a-github-app/making-a-github-app-public-or-private.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ versions:
1717
ghec: '*'
1818
topics:
1919
- GitHub Apps
20-
shortTitle: Manage app visibility
20+
shortTitle: Visibility
2121
---
2222

2323
## About visibility for {% data variables.product.prodname_github_app %}s

content/apps/creating-github-apps/guides/migrating-oauth-apps-to-github-apps.md renamed to content/apps/creating-github-apps/setting-up-a-github-app/migrating-oauth-apps-to-github-apps.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,15 @@ redirect_from:
55
- /apps/migrating-oauth-apps-to-github-apps
66
- /developers/apps/migrating-oauth-apps-to-github-apps
77
- /developers/apps/getting-started-with-apps/migrating-oauth-apps-to-github-apps
8+
- /apps/creating-github-apps/guides/migrating-oauth-apps-to-github-apps
89
versions:
910
fpt: '*'
1011
ghes: '*'
1112
ghae: '*'
1213
ghec: '*'
1314
topics:
1415
- GitHub Apps
15-
shortTitle: Migrate from {% data variables.product.prodname_oauth_app %}s
16+
shortTitle: 'Migrate from {% data variables.product.prodname_oauth_app %}s'
1617
---
1718

1819
## Benefits of migrating from {% data variables.product.prodname_oauth_app %}s to {% data variables.product.prodname_github_app %}s

content/apps/creating-github-apps/setting-up-a-github-app/using-webhooks-with-github-apps.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Using webhooks with GitHub Apps
3-
shortTitle: Using webhooks
3+
shortTitle: Webhooks
44
intro: 'Your {% data variables.product.prodname_github_app %} can subscribe to webhook events to receive notifications whenever certain activity occurs.'
55
versions:
66
fpt: '*'

content/apps/index.md

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,20 +4,26 @@ shortTitle: Apps
44
intro: 'Go deeper with {% data variables.product.prodname_dotcom %} by integrating with our APIs and webhooks, customizing your {% data variables.product.prodname_dotcom %} workflow, and building and sharing apps with the community.'
55
introLinks:
66
overview: /apps/overview
7+
quickstart: /apps/creating-github-apps/guides/quickstart
78
layout: product-landing
89
featuredLinks:
910
startHere:
10-
- /apps/creating-github-apps/setting-up-a-github-app/about-apps
11+
- /apps/using-github-apps/about-using-github-apps
12+
- /apps/creating-github-apps/setting-up-a-github-app/about-creating-github-apps
1113
- /apps/creating-github-apps/setting-up-a-github-app/differences-between-github-apps-and-oauth-apps
12-
- /apps/creating-github-apps/setting-up-a-github-app/creating-a-github-app
1314
- /apps/creating-github-apps/authenticating-with-a-github-app/about-authentication-with-a-github-app
1415
popular:
1516
- /apps/creating-github-apps/setting-up-a-github-app/creating-a-github-app
16-
- /apps/creating-github-apps/authenticating-with-a-github-app/about-authentication-with-a-github-app
17-
- /apps/publishing-apps-to-github-marketplace/github-marketplace-overview/about-github-marketplace
17+
- /apps/using-github-apps/authorizing-github-apps
18+
- /apps/creating-github-apps/guides/building-a-github-app-that-responds-to-webhook-events
19+
- /apps/creating-github-apps/guides/building-a-login-with-github-button-with-a-github-app
20+
- /apps/creating-github-apps/guides/building-a-cli-with-a-github-app
21+
- /apps/creating-github-apps/guides/making-authenticated-api-requests-with-a-github-app-in-a-github-actions-workflow
1822
guideCards:
19-
- /apps/creating-github-apps/guides/creating-ci-tests-with-the-checks-api
20-
- /apps/creating-github-apps/guides/using-the-github-api-in-your-app
23+
- /apps/creating-github-apps/guides/building-a-github-app-that-responds-to-webhook-events
24+
- /apps/creating-github-apps/guides/building-a-login-with-github-button-with-a-github-app
25+
- /apps/creating-github-apps/guides/building-a-cli-with-a-github-app
26+
- /apps/creating-github-apps/guides/making-authenticated-api-requests-with-a-github-app-in-a-github-actions-workflow
2127
changelog:
2228
label: apps
2329
versions:
@@ -31,6 +37,7 @@ children:
3137
- /overview
3238
- /using-github-apps
3339
- /creating-github-apps
40+
- /sharing-github-apps
3441
- /maintaining-github-apps
3542
- /publishing-apps-to-github-marketplace
3643
- /oauth-apps

content/apps/maintaining-github-apps/deleting-a-github-app.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
title: Deleting a GitHub App
3+
shortTitle: Delete your app
34
intro: 'You can delete {% data variables.product.prodname_github_app %}s that you own if you no longer want to use or maintain the app.'
45
redirect_from:
56
- /apps/building-integrations/managing-github-apps/deleting-a-github-app

content/apps/maintaining-github-apps/index.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,12 +13,10 @@ versions:
1313
topics:
1414
- GitHub Apps
1515
children:
16-
- /about-github-app-managers
1716
- /modifying-a-github-app
18-
- /managing-allowed-ip-addresses-for-a-github-app
19-
- /installing-your-own-github-app
20-
- /sharing-your-github-app
2117
- /activating-optional-features-for-github-apps
18+
- /about-github-app-managers
19+
- /managing-allowed-ip-addresses-for-a-github-app
2220
- /suspending-a-github-app-installation
2321
- /transferring-ownership-of-a-github-app
2422
- /deleting-a-github-app

content/apps/maintaining-github-apps/modifying-a-github-app.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
title: Modifying a GitHub App
3+
shortTitle: Modify app settings
34
intro: '{% data reusables.shortdesc.modifying_github_apps %}'
45
redirect_from:
56
- /apps/building-integrations/managing-github-apps/modifying-a-github-app

content/apps/maintaining-github-apps/suspending-a-github-app-installation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ versions:
1212
ghec: '*'
1313
topics:
1414
- GitHub Apps
15-
shortTitle: Suspend app installation
15+
shortTitle: Suspend an installation
1616
---
1717

1818
When a {% data variables.product.prodname_github_app %} is suspended for an installation, the {% data variables.product.prodname_github_app %} cannot access resources owned by that installation account. For example, you might want to suspend your {% data variables.product.prodname_github_app %} if you are worried that your app's credentials were leaked.

content/apps/oauth-apps/building-oauth-apps/authenticating-to-the-rest-api-with-an-oauth-app.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Authenticating to the REST API with an OAuth App
3-
shortTitle: Authenticating with OAuth App
3+
shortTitle: Authenticate with an OAuth App
44
intro: Learn about the different ways to authenticate with some examples.
55
redirect_from:
66
- /guides/basics-of-authentication

content/apps/oauth-apps/building-oauth-apps/authorizing-oauth-apps.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,11 @@ topics:
2121

2222
{% note %}
2323

24-
**Note**: Consider building a {% data variables.product.prodname_github_app %} instead of an {% data variables.product.prodname_oauth_app %}. {% data variables.product.prodname_github_app %}s can act on behalf of a user, similar to an {% data variables.product.prodname_oauth_app %}, or as themselves, which is beneficial for automations that do not require user input. Additionally, {% data variables.product.prodname_github_app %}s use fine grained permissions, give the user more control over which repositories the app can access, and use short-lived tokens. For more information, see "[AUTOTITLE](/apps/oauth-apps/building-oauth-apps/differences-between-github-apps-and-oauth-apps)" and "[AUTOTITLE](/apps/creating-github-apps/setting-up-a-github-app/about-creating-github-apps)."
24+
**Note**: Consider building a {% data variables.product.prodname_github_app %} instead of an {% data variables.product.prodname_oauth_app %}.
25+
26+
Both {% data variables.product.prodname_oauth_app %}s and {% data variables.product.prodname_github_app %}s use OAuth 2.0.
27+
28+
{% data variables.product.prodname_github_app %}s can act on behalf of a user, similar to an {% data variables.product.prodname_oauth_app %}, or as themselves, which is beneficial for automations that do not require user input. Additionally, {% data variables.product.prodname_github_app %}s use fine grained permissions, give the user more control over which repositories the app can access, and use short-lived tokens. For more information, see "[AUTOTITLE](/apps/oauth-apps/building-oauth-apps/differences-between-github-apps-and-oauth-apps)" and "[AUTOTITLE](/apps/creating-github-apps/setting-up-a-github-app/about-creating-github-apps)."
2529

2630
{% endnote %}
2731

content/apps/oauth-apps/building-oauth-apps/creating-an-oauth-app.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,15 @@ topics:
1717

1818
{% note %}
1919

20-
**Note**: Consider building a {% data variables.product.prodname_github_app %} instead of an {% data variables.product.prodname_oauth_app %}. {% data variables.product.prodname_github_app %}s use fine-grained permissions, give the user more control over which repositories the app can access, and use short-lived tokens. For more information, see "[AUTOTITLE](/apps/oauth-apps/building-oauth-apps/differences-between-github-apps-and-oauth-apps)" and "[AUTOTITLE](/apps/creating-github-apps/setting-up-a-github-app/about-creating-github-apps)."
20+
**Note**: Consider building a {% data variables.product.prodname_github_app %} instead of an {% data variables.product.prodname_oauth_app %}.
21+
22+
Both {% data variables.product.prodname_oauth_app %}s and {% data variables.product.prodname_github_app %}s use OAuth 2.0.
23+
24+
{% data variables.product.prodname_oauth_app %}s can only act on behalf of a user while {% data variables.product.prodname_github_app %}s can either act on behalf of a user or independently of a user.
25+
26+
{% data variables.product.prodname_github_app %}s use fine-grained permissions, give the user more control over which repositories the app can access, and use short-lived tokens.
27+
28+
For more information, see "[AUTOTITLE](/apps/oauth-apps/building-oauth-apps/differences-between-github-apps-and-oauth-apps)" and "[AUTOTITLE](/apps/creating-github-apps/setting-up-a-github-app/about-creating-github-apps)."
2129

2230
{% endnote %}
2331

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ redirect_from:
66
- /developers/apps/creating-a-github-app-from-a-manifest
77
- /developers/apps/building-github-apps/creating-a-github-app-from-a-manifest
88
- /apps/creating-github-apps/creating-github-apps/creating-a-github-app-from-a-manifest
9+
- /apps/creating-github-apps/setting-up-a-github-app/creating-a-github-app-from-a-manifest
910
versions:
1011
fpt: '*'
1112
ghes: '*'
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ redirect_from:
66
- /developers/apps/creating-a-github-app-using-url-parameters
77
- /developers/apps/building-github-apps/creating-a-github-app-using-url-parameters
88
- /apps/creating-github-apps/creating-github-apps/creating-a-github-app-using-url-parameters
9+
- /apps/creating-github-apps/setting-up-a-github-app/creating-a-github-app-using-url-parameters
910
versions:
1011
fpt: '*'
1112
ghes: '*'
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
title: 'Sharing {% data variables.product.prodname_github_apps %}'
3+
intro: 'After you create a public {% data variables.product.prodname_github_app %}, you can share your {% data variables.product.prodname_github_app %} with other {% data variables.product.company_short %} users.'
4+
versions:
5+
fpt: '*'
6+
ghes: '*'
7+
ghae: '*'
8+
ghec: '*'
9+
topics:
10+
- GitHub Apps
11+
children:
12+
- /sharing-your-github-app
13+
- /making-your-github-app-available-for-github-enterprise-server
14+
- /creating-a-github-app-from-a-manifest
15+
- /creating-a-github-app-using-url-parameters
16+
---
17+
Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,19 @@ versions:
99
ghec: '*'
1010
topics:
1111
- GitHub Apps
12+
redirect_from:
13+
- /apps/creating-github-apps/setting-up-a-github-app/making-your-github-app-available-for-github-enterprise-server
1214
---
1315

1416
## About developing {% data variables.product.prodname_github_app %}s for {% data variables.product.prodname_ghe_server %}
1517

1618
If you want your {% data variables.product.prodname_github_app %} to be available to organizations in a {% data variables.product.prodname_ghe_server %} instance that you are not part of, you must take the following steps.
1719

18-
These steps are not required if your {% data variables.product.prodname_github_app %} will only be used by organizations in a {% data variables.product.prodname_ghe_server %} instance that you are part of.
20+
{% ifversion ghes %}
21+
These steps are not required if your {% data variables.product.prodname_github_app %} will only be used by organizations in a {% data variables.product.prodname_ghe_server %} instance that you are part of. For more information, see "[AUTOTITLE](/apps/maintaining-github-apps/installing-your-own-github-app)."
22+
{% endif %}
23+
24+
If {% data variables.product.prodname_ghe_server %} access is important, consider whether a custom action for {% data variables.product.prodname_actions %} will suit your needs instead. Public actions are available on {% data variables.product.prodname_ghe_server %} instances with {% data variables.product.prodname_github_connect %}. For more information, see {% ifversion ghes %}"[AUTOTITLE](/admin/github-actions/managing-access-to-actions-from-githubcom/enabling-automatic-access-to-githubcom-actions-using-github-connect)."{% else %}"[AUTOTITLE](/enterprise-server@latest/admin/github-actions/managing-access-to-actions-from-githubcom/enabling-automatic-access-to-githubcom-actions-using-github-connect)" in the {% data variables.product.prodname_ghe_server %} documentation.{% endif %}
1925

2026
## Each {% data variables.product.prodname_ghe_server %} instance must create their own {% data variables.product.prodname_github_app %}
2127

content/apps/maintaining-github-apps/sharing-your-github-app.md renamed to content/apps/sharing-github-apps/sharing-your-github-app.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,13 @@ versions:
77
ghae: '*'
88
ghes: '*'
99
shortTitle: Share your app
10+
redirect_from:
11+
- /apps/maintaining-github-apps/sharing-your-github-app
1012
---
1113

1214
{% ifversion fpt or ghec %}
1315

14-
### Sharing your {% data variables.product.prodname_github_app %} on {% data variables.product.prodname_marketplace %}
16+
## Sharing your {% data variables.product.prodname_github_app %} on {% data variables.product.prodname_marketplace %}
1517

1618
If your {% data variables.product.prodname_github_app %} is public, you can choose to publish it to {% data variables.product.prodname_marketplace %}. For more information, see "[AUTOTITLE](/apps/publishing-apps-to-github-marketplace/github-marketplace-overview/about-github-marketplace)."
1719

@@ -21,7 +23,7 @@ For more information about how users can install your app from {% data variables
2123

2224
{% endif %}
2325

24-
### Sharing your {% data variables.product.prodname_github_app %} via an install link
26+
## Sharing your {% data variables.product.prodname_github_app %} via an install link
2527

2628
{% ifversion fpt or ghec %}
2729
If your {% data variables.product.prodname_github_app %} is public, other users and organizations {% ifversion ghae or ghec %}within your enterprise {% endif %}can install your app. For more information about making your app public, see "[AUTOTITLE](/apps/creating-github-apps/setting-up-a-github-app/making-a-github-app-public-or-private)."
@@ -42,3 +44,7 @@ If your {% data variables.product.prodname_github_app %} is public, other users
4244
When you share the URL, you can include a `state` query parameter in the installation URL to preserve the state of the application page and return people back to that state after they install, authenticate, or accept updates to your GitHub App. For example, you could use the `state` to correlate an installation to a user or account.
4345

4446
To preserve a state, add it to the installation URL: `{% data variables.product.oauth_host_code %}/{% ifversion ghes or ghae %}github-apps{% else %}apps{% endif %}/<app name>/installations/new?state=AB12t`
47+
48+
## Sharing your {% data variables.product.prodname_github_app %} with {% data variables.product.prodname_ghe_server %} instances
49+
50+
If you want to share your {% data variables.product.prodname_github_app %} with {% data variables.product.prodname_ghe_server %} instances that you are not part of, you need to take additional steps. For more information, see "[AUTOTITLE](/apps/creating-github-apps/setting-up-a-github-app/making-your-github-app-available-for-github-enterprise-server)."

0 commit comments

Comments
 (0)