Skip to content

Commit cb390d7

Browse files
authored
Add additional info about sharing apps with GHES (#37326)
1 parent 5e0c864 commit cb390d7

File tree

2 files changed

+11
-3
lines changed

2 files changed

+11
-3
lines changed

content/apps/sharing-github-apps/making-your-github-app-available-for-github-enterprise-server.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,11 @@ redirect_from:
1717

1818
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.
1919

20-
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 %}
2125

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

content/apps/sharing-github-apps/sharing-your-github-app.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ redirect_from:
1313

1414
{% ifversion fpt or ghec %}
1515

16-
### 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 %}
1717

1818
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)."
1919

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

2424
{% endif %}
2525

26-
### 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
2727

2828
{% ifversion fpt or ghec %}
2929
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)."
@@ -44,3 +44,7 @@ If your {% data variables.product.prodname_github_app %} is public, other users
4444
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.
4545

4646
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)