Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit e738bfd

Browse files
Sarah Edwardsindigoksaritai
authored
Add overview article about using GitHub Apps (#36712)
Co-authored-by: Indigo <[email protected]> Co-authored-by: Sarita Iyer <[email protected]>
1 parent a0ee2c4 commit e738bfd

3 files changed

Lines changed: 39 additions & 0 deletions

File tree

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
title: About creating GitHub Apps
3+
shortTitle: About creating apps
34
intro: "{% data variables.product.prodname_github_app %}s let you build integrations to automate processes and extend {% data variables.product.company_short %}'s functionality."
45
versions:
56
fpt: '*'
Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
---
2+
title: About using GitHub Apps
3+
shortTitle: About using apps
4+
intro: "Learn about what a {% data variables.product.prodname_github_app %} is and why you would use a {% data variables.product.prodname_github_app %}."
5+
versions:
6+
fpt: '*'
7+
ghes: '*'
8+
ghae: '*'
9+
ghec: '*'
10+
topics:
11+
- GitHub Apps
12+
---
13+
14+
## About {% data variables.product.prodname_github_app %}s
15+
16+
{% data variables.product.prodname_github_app %}s are tools that extend {% data variables.product.company_short %}'s functionality. {% data variables.product.prodname_github_app %}s can do things on {% data variables.product.company_short %} like open issues, comment on pull requests, and manage projects. They can also do things outside of {% data variables.product.company_short %} based on events that happen on {% data variables.product.company_short %}. For example, a {% data variables.product.prodname_github_app %} can post on Slack when an issue is opened on {% data variables.product.company_short %}.
17+
18+
## Finding {% data variables.product.prodname_github_app %}s
19+
20+
{% ifversion fpt or ghec %}
21+
You can discover {% data variables.product.prodname_github_app %}s on {% data variables.product.prodname_marketplace %}. For more information, see "[AUTOTITLE](/get-started/exploring-integrations/about-github-marketplace)."{% else %}You cannot install third-party applications on your enterprise. If you want to use the functionality of a third-party app, you can contact the app developer about creating an app from a manifest or from URL parameters. For more information, see "[AUTOTITLE](/apps/creating-github-apps/setting-up-a-github-app/creating-a-github-app-from-a-manifest)" and "[AUTOTITLE](/apps/creating-github-apps/setting-up-a-github-app/creating-a-github-app-using-url-parameters)."{% endif %}
22+
23+
You can also build your own {% data variables.product.prodname_github_app %}. For more information, see "[AUTOTITLE](/apps/creating-github-apps/setting-up-a-github-app/about-creating-github-apps)."
24+
25+
## Using {% data variables.product.prodname_github_app %}s
26+
27+
In order to use a {% data variables.product.prodname_github_app %}, you must install the app on your user or organization account. When you install the app, you grant the app permission to read or modify your repository and organization data. The specific permissions depends on the app, and {% data variables.product.company_short %} will tell you what permissions the app requested before you install the app. When you install the app, you will also specify what repositories the app can access. If the app requires any additional configuration, the app will direct you to do so. For more information, see {% ifversion ghec or fpt %}"[AUTOTITLE](/apps/using-github-apps/installing-an-app-in-your-personal-account)" and "[AUTOTITLE](/apps/using-github-apps/installing-an-app-in-your-organization)."{% else %}"[AUTOTITLE](/apps/maintaining-github-apps/installing-github-apps)."{% endif %}
28+
29+
You may also need to authorize a {% data variables.product.prodname_github_app %} to verify your identity, know what resources you can access, or take actions on your behalf. If you need to authorize the app, the app will prompt you to do so. For more information, see "[AUTOTITLE](/apps/using-github-apps/authorizing-github-apps)."
30+
31+
Occasionally, the {% data variables.product.prodname_github_app %} will request updated permissions. {% data variables.product.company_short %} will notify you when this occurs. In order for the app to continue to function, you will need to review and approve the updated permissions.
32+
33+
Before you install or authorize a {% data variables.product.prodname_github_app %}, you should make sure that you trust the app developer. If you no longer use the app, you should suspend or uninstall the app and/or revoke your authorization of the app. For more information, see "[AUTOTITLE](/apps/maintaining-github-apps/suspending-a-github-app-installation)" and "[AUTOTITLE](/apps/using-github-apps/reviewing-your-authorized-integrations)."
34+
35+
## {% data variables.product.prodname_github_app %}s and OAuth Apps
36+
37+
{% data variables.product.company_short %} also supports OAuth Apps. Unlike {% data variables.product.prodname_github_app %}s, you do not install an OAuth App or control what repositories it can access. For more information, see "[AUTOTITLE](/apps/oauth-apps/using-oauth-apps/authorizing-oauth-apps)."

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ versions:
1212
ghec: '*'
1313
shortTitle: 'Using {% data variables.product.prodname_github_apps %}'
1414
children:
15+
- /about-using-github-apps
1516
- /installing-an-app-in-your-personal-account
1617
- /installing-an-app-in-your-organization
1718
- /authorizing-github-apps

0 commit comments

Comments
 (0)