You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
description: Learn how to automate DevOps processes by using GitHub Apps that handle repetitive tasks, enforce team policies, and maintain a tidy repository.
description: Learn how to automate DevOps processes by using GitHub Apps that handle repetitive tasks, enforce team policies, and maintain a tidy repository.
description: Learn to automate DevOps processes by using GitHub Apps that handle repetitive tasks, enforce team policies, and maintain a tidy repository.
description: Learn to automate DevOps processes by using GitHub Apps that handle repetitive tasks, enforce team policies, and maintain a tidy repository.
title: Exercise - Getting started with GitHub Apps
4
-
metadata:
5
-
title: Exercise - Getting started with GitHub Apps
6
-
description: Learn to automate DevOps processes by using GitHub Apps that handle repetitive tasks, enforce team policies, and maintain a tidy repository.
title: Exercise - Getting started with GitHub Apps
4
+
metadata:
5
+
title: Exercise - Getting started with GitHub Apps
6
+
description: Learn to automate DevOps processes by using GitHub Apps that handle repetitive tasks, enforce team policies, and maintain a tidy repository.
Copy file name to clipboardExpand all lines: learn-pr/github/automate-devops-github-apps/includes/1-introduction.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
When thinking about ways to add efficiency within your GitHub workflow, consider that you can build apps and integrations to improve and customize your workflow. By using GitHub Apps and OAuth Apps, you can help reduce the amount of time spent on manual tasks and customize your workflow to meet individual, team, and company needs. You can also share these integrations with others on GitHub Marketplace, and in return use apps and integrations built by other developers.
2
2
3
-
Suppose you're looking for a feature that GitHub doesn't yet support. Maybe you'd like to automate some of the more mundane tasks you deal with. Such as, following up with contributors who didn't label an issue they created. Or maybe you'd like to automatically close any branches or pull requests that haven't been touched in months. Whatever your need is, you're probably not alone. The good news is that GitHub Apps offer a way for you to fill the gaps and automate processes in your repository. The better news is that someone else might have already built the solution you need.
3
+
Suppose you're looking for a feature that GitHub doesn't yet support. Maybe you'd like to automate some of the more mundane tasks you deal with. For example, following up with contributors who didn't label an issue they created. Or automatically closing any branches or pull requests that remain untouched for months. Whatever your need is, you're probably not alone. The good news is that GitHub Apps offer a way for you to fill the gaps and automate processes in your repository. The better news is that the solution you need might already be built.
4
4
5
5
Optimizing the value of apps and features to manage users in your workflow can help speed up your processes while maintaining efficiency, security, and reliability. In this module, you learn about using these tools and their features.
Copy file name to clipboardExpand all lines: learn-pr/github/automate-devops-github-apps/includes/2-what-are-github-apps.md
+11-7Lines changed: 11 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,9 +8,9 @@ There are several factors to consider when choosing between incorporating an OAu
8
8
9
9
:::image type="content" source="../media/gh-apps-oauth-apps.png" alt-text="Image of an install icon and an approve icon for GitHub Apps and OAuth Apps." :::
10
10
11
-
When customizing a GitHub workflow, you have several features available. Such as, writing custom scripts, creating and authorizing your own OAuth Apps, or installing GitHub Apps available from the GitHub marketplace. In general, you can best use scripts for those one-off tasks. For actions that need to be run more often, you can use the automation of OAuth and GitHub Apps to help you and your team save time while retaining the optimal level of security within your workflows. There are many differences that affect how you decide between using a GitHub App or OAuth App. Understanding these differences beforehand can reduce some headaches and rework down the road, and help you find the best application for your specific use case within your workflow.
11
+
When customizing a GitHub workflow, you have several features available. Such as, writing custom scripts, creating and authorizing your own OAuth Apps, or installing GitHub Apps available from the GitHub marketplace. In general, you can best use scripts for those one-off tasks. For actions that are run more often, the automation of OAuth and GitHub Apps can help you and your team save time, while retaining the optimal level of security within your workflows. There are many differences that affect how you decide between using a GitHub App or OAuth App. Understanding these differences beforehand can reduce some headaches and rework down the road, and help you find the best application for your specific use case within your workflow.
12
12
13
-
At the end of this section, you'll have a good understanding of the differences between a GitHub App and an OAuth App, and know how to best choose an app for the right situation.
13
+
At the end of this section, you should have a good understanding of the differences between a GitHub App and an OAuth App, and know how to best choose an app for the right situation.
14
14
15
15
## Granting access and permissions
16
16
@@ -34,9 +34,13 @@ For organizations with OAuth App access restrictions, the Administrator is able
34
34
35
35
By contrast, GitHub Apps are *installed* in your personal account, organizations you own, or specific repositories in which you have admin access. GitHub Apps are installed and interact with GitHub as a service, not an individual user as with OAuth Apps. One benefit of GitHub Apps is that, unlike OAuth apps, GitHub Apps don't consume a GitHub license.
36
36
37
-
GitHub Apps access data on behalf of the application itself through a Private Key that's used to sign a JSON Web Token. Because they're installed on specific repositories, users can choose what repositories the app can access, which limits the amount of data the app is able to access. Permissions define what resources the GitHub App can access via the API. Unlike OAuth Apps, GitHub Apps have customizable permissions for repository data, issues, and pull requests. This allows you to grant more granular permissions, limiting the app to read and write in only the repositories it has been allowed to access. Only organization owners can manage the setting of GitHub Apps in an organization.
37
+
GitHub Apps access data on behalf of the application itself through a Private Key that's used to sign a JSON Web Token. Because they're installed on specific repositories, users can choose what repositories the app can access, which limits the amount of data the app is able to access. Permissions define what resources the GitHub App can access via the API. Unlike OAuth Apps, GitHub Apps have customizable permissions for repository data, issues, and pull requests. Customization allows you to grant more granular permissions, limiting the app to read and write only in the repositories you allow it to access. Only organization owners can manage the setting of GitHub Apps in an organization.
38
38
39
-
You can find and install GitHub Apps from the GitHub Marketplace. When you're searching for GitHub Apps, keep in mind that some Apps have a verified badge. This badge shows that the app is owned by an organization that has verified ownership of their domain, confirmed their email addresses with GitHub Support, and requires two-factor authentication for their organization.
39
+
You can find and install GitHub Apps from the GitHub Marketplace. When you're searching for GitHub Apps, keep in mind that some Apps have a *verified badge*. A verified badge indicates the following about the app and the organization that owns it:
40
+
41
+
- The organization's ownership of their domain is verified.
42
+
- GitHub Support confirms the email addresses for the organization.
43
+
- The organization requires two-factor authentication.
40
44
41
45
:::image type="content" source="../media/apps-badge.png" alt-text="Image of a verified badge for a GitHub App." :::
42
46
@@ -46,7 +50,7 @@ You can find and install GitHub Apps from the GitHub Marketplace. When you're se
46
50
47
51
## Choose between GitHub Apps and OAuth Apps
48
52
49
-
While GitHub Apps are an ideal way to integrate into your workflow in some situations, it can be challenging for larger organizations to make the transition from the traditional use of OAuth Apps for automation. For example, a security-policy restriction might also limit an administrator's options in choosing to use these tools.
53
+
While GitHub Apps are an ideal way to integrate into your workflow in some situations, larger organizations can find it challenging to make the transition from the traditional use of OAuth Apps for automation. For example, a security-policy restriction might also limit an administrator's options in choosing to use these tools.
50
54
51
55
> [!NOTE]
52
56
> As the System Administrator, you should work with your developers to find options that are the best-fit for automation by using these applications while still following your security policy.
@@ -65,7 +69,7 @@ Here are some key characteristics and differences to consider when choosing betw
65
69
| Installing a GitHub App grants the app access to a user or organization account's chosen repositories. | Authorizing an OAuth App grants the app access to the user's accessible resources; for example, repositories they can access. |
66
70
| Installation access tokens are limited to specified repositories with the permissions chosen by the app's creator. | An OAuth access token is limited via scopes. |
67
71
| An installation token identifies the app as the GitHub Apps bot. | An access token identifies the app as the user who granted the token to the app. |
68
-
| GitHub Apps have targeted permissions that allow them to request access only to what they need. | OAuth Apps can't use granular permissions. |
72
+
| GitHub Apps use targeted permissions that allow them to request access only to what they need. | OAuth Apps can't use granular permissions. |
69
73
| GitHub Apps aren't subject to organization application policies. A GitHub App only has access to the repositories that an organization owner grants. | If an organization application policy is active, only an organization owner can authorize the installation of an OAuth App. If installed, the OAuth App gains access to anything visible to the token the organization owner has within the approved organization. |
70
74
| Rate limit increases can be granted both at the GitHub Apps level (affecting all installations) and at the individual installation level. | Rate limit increases are granted per OAuth App. Every token granted to that OAuth App gets the increased limit. |
71
75
| GitHub Apps can authenticate on behalf of the user, which is called user-to-server requests. The flow to authorize is the same as the OAuth App authorization flow. User-to-server tokens can expire and be renewed with a refresh token. | The OAuth flow used by OAuth Apps authorizes an OAuth App on behalf of the user. This flow is the same one used in GitHub App user-to-server authorization. |
@@ -95,7 +99,7 @@ GitHub Apps are designed to be passive. They wait for something to happen and th
95
99
96
100
### Using GitHub webhooks
97
101
98
-
Webhooks are the preferred approach for event handling. When something happens on GitHub within the scope of a webhook, it's raised immediately. Webhooks push notifications that your app can listen for and process in real time. You can configure webhooks in your repository settings, including the types of events, authentication, and way the HTTP notifications are delivered.
102
+
Webhooks are the preferred approach for event handling. When something happens on GitHub within the scope of a webhook, an event is raised immediately. Webhooks push notifications that your app can listen for and process in real time. You can configure webhooks in your repository settings, including the types of events, authentication, and way the HTTP notifications are delivered.
0 commit comments