jprdonnelly/docs
1
0
Fork 0
mirror of synced 2025-12-21 02:46:50 -05:00
Code Issues Projects Releases Wiki Activity

GitHub Apps "beta features" are now "optional features" (#17640)

Browse Source 
Co-authored-by: Lucas Costi <lucascosti@users.noreply.github.com>
This commit is contained in:
Sarah Edwards
2021-02-10 15:50:21 -08:00
committed by GitHub
parent 5c0cf9ae69
commit aefb091588
14 changed files with 60 additions and 64 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
content/developers/apps/activating-beta-features-for-apps.md
View File

@@ -1,28 +0,0 @@
---
title: Activating beta features for apps
intro: 'You can test new app features released in public beta for your {% data variables.product.prodname_github_apps %} and {% data variables.product.prodname_oauth_app %}s.'
versions:
free-pro-team: '*'
enterprise-server: '>=2.22'
github-ae: '*'
---
{% warning %}
**Warning:** Features available in public beta are subject to change.
{% endwarning %}
### Activating beta features for {% data variables.product.prodname_github_apps %}
{% data reusables.user-settings.access_settings %}
{% data reusables.user-settings.developer_settings %}
3. Select the {% data variables.product.prodname_github_app %} you want to enable a beta feature for.
{% data reusables.apps.beta_feature_activation %}
### Activating beta features for {% data variables.product.prodname_oauth_app %}s
{% data reusables.user-settings.access_settings %}
{% data reusables.user-settings.developer_settings %}
{% data reusables.user-settings.oauth_apps %}
{% data reusables.apps.beta_feature_activation %}

30
content/developers/apps/activating-optional-features-for-apps.md Normal file
View File

@@ -0,0 +1,30 @@
---
title: Activating optional features for apps
intro: 'You can test new optional features for your {% data variables.product.prodname_github_apps %} and {% data variables.product.prodname_oauth_app %}s.'
redirect_from:
- /developers/apps/activating-beta-features-for-apps
versions:
free-pro-team: '*'
github-ae: '*'
enterprise-server: '>=2.22'
---
{% warning %}
**Warning:** {% if currentVersion ver_lt "enterprise-server@3.1" %} Beta {% else %} Optional {% endif %} features are subject to change.
{% endwarning %}
### Activating {% if currentVersion ver_lt "enterprise-server@3.1" %} beta {% else %} optional {% endif %} features for {% data variables.product.prodname_github_apps %}
{% data reusables.user-settings.access_settings %}
{% data reusables.user-settings.developer_settings %}
3. Select the {% data variables.product.prodname_github_app %} you want to enable {% if currentVersion ver_lt "enterprise-server@3.1" %} a beta {% else %} an optional {% endif %} feature for.
{% data reusables.apps.optional_feature_activation %}
### Activating {% if currentVersion ver_lt "enterprise-server@3.1" %} beta {% else %} optional {% endif %} features for {% data variables.product.prodname_oauth_app %}s
{% data reusables.user-settings.access_settings %}
{% data reusables.user-settings.developer_settings %}
{% data reusables.user-settings.oauth_apps %}
{% data reusables.apps.optional_feature_activation %}

8
content/developers/apps/identifying-and-authorizing-users-for-github-apps.md
View File

@@ -12,7 +12,7 @@ versions:
---
{% data reusables.pre-release-program.expiring-user-access-tokens-beta %}
{% data reusables.pre-release-program.expiring-user-access-tokens %}
When your GitHub App acts on behalf of a user, it performs user-to-server requests. These requests must be authorized with a user's access token. User-to-server requests include requesting data for a user, like determining which repositories to display to a particular user. These requests also include actions triggered by a user, like running a build.
@@ -67,9 +67,9 @@ If the user accepts your request, GitHub redirects back to your site with a temp
{% endnote %}
Exchange this `code` for an access token. {% if currentVersion == "free-pro-team@latest" %} When expiring tokens are enabled, the access token expires in 8 hours and the refresh token expires in 6 months. Every time you refresh the token, you get a new refresh token. For more information, see "[Refreshing user-to-server access tokens](/developers/apps/refreshing-user-to-server-access-tokens)."
Exchange this `code` for an access token. {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" or currentVersion == "github-ae@latest" %} When expiring tokens are enabled, the access token expires in 8 hours and the refresh token expires in 6 months. Every time you refresh the token, you get a new refresh token. For more information, see "[Refreshing user-to-server access tokens](/developers/apps/refreshing-user-to-server-access-tokens)."
Expiring user tokens are currently part of the user-to-server token expiration beta and subject to change. To opt-in to the user-to-server token expiration beta feature, see "[Activating beta features for apps](/developers/apps/activating-beta-features-for-apps)."{% endif %}
Expiring user tokens are currently an optional feature and subject to change. To opt-in to the user-to-server token expiration feature, see "[Activating optional features for apps](/developers/apps/activating-optional-features-for-apps)."{% endif %}
POST {% data variables.product.oauth_host_code %}/login/oauth/access_token
@@ -87,7 +87,7 @@ Name | Type | Description
{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" or currentVersion == "github-ae@latest" %}
By default, the response takes the following form. The response parameters `expires_in`, `refresh_token`, and `refresh_token_expires_in` are only returned when you enable the beta for expiring user-to-server access tokens.
By default, the response takes the following form. The response parameters `expires_in`, `refresh_token`, and `refresh_token_expires_in` are only returned when you enable expiring user-to-server access tokens.
```json
{

2
content/developers/apps/index.md
View File

@@ -17,7 +17,7 @@ versions:
{% topic_link_in_list /getting-started-with-apps %}
{% link_in_list /about-apps %}
{% link_in_list /activating-beta-features-for-apps %}
{% link_in_list /activating-optional-features-for-apps %}
{% link_in_list /differences-between-github-apps-and-oauth-apps %}
{% link_in_list /migrating-oauth-apps-to-github-apps %}
{% link_in_list /setting-up-your-development-environment-to-create-a-github-app %}

6
content/developers/apps/refreshing-user-to-server-access-tokens.md
View File

@@ -10,7 +10,7 @@ versions:
---
{% data reusables.pre-release-program.expiring-user-access-tokens-beta %}
{% data reusables.pre-release-program.expiring-user-access-tokens %}
### About expiring user access tokens
@@ -57,8 +57,8 @@ You can enable or disable expiring user-to-server authorization tokens from your
{% data reusables.user-settings.github_apps %}
4. Click **Edit** next to your chosen {% data variables.product.prodname_github_app %}.
![Settings to edit a GitHub App](/assets/images/github-apps/edit-test-app.png)
5. In the left sidebar, click **Beta Features**.
![Beta Features menu option](/assets/images/github-apps/beta-features-option.png)
5. In the left sidebar, click **{% if currentVersion ver_lt "enterprise-server@3.1" %} Beta {% else %} Optional {% endif %} Features**.
{% if currentVersion ver_lt "enterprise-server@3.1" %} ![Beta features tab](/assets/images/github-apps/beta-features-option.png) {% else %} ![Optional features tab](/assets/images/github-apps/optional-features-option.png) {% endif %}
6. Next to "User-to-server token expiration", click **Opt-in** or **Opt-out**. This setting may take a couple of seconds to apply.
### Opting out of expiring tokens for new GitHub Apps

10
content/developers/apps/suspending-a-github-app-installation.md
View File

@@ -9,22 +9,16 @@ versions:
github-ae: '*'
---
{% note %}
**Note:** {% data reusables.pre-release-program.suspend-installation-beta %}
{% endnote %}
### Suspending a GitHub App
The integrator who owns and maintains a GitHub app, also called a GitHub App owner, can suspend or unsuspend a GitHub App installation using REST API endpoints with a JWT. For more information, see the [GitHub Apps REST API](/rest/reference/apps).
People who have installed a GitHub App, also called installation owners, can only suspend or unsuspend a GitHub App through their app's installation settings. Installation owners cannot use the API to suspend or unsuspend their app installation. Before people can suspend a GitHub app installation, the GitHub App owner must opt-in to the beta release. For more information, see "[Suspending a GitHub App installation](/apps/managing-github-apps/suspending-a-github-app-installation/)."
People who have installed a GitHub App, also called installation owners, can only suspend or unsuspend a GitHub App through their app's installation settings. Installation owners cannot use the API to suspend or unsuspend their app installation.
{% data reusables.user-settings.access_settings %}
{% data reusables.user-settings.developer_settings %}
{% data reusables.user-settings.github_apps %}
4. Select the {% data variables.product.prodname_github_app %} you want to suspend.
1. Select the {% data variables.product.prodname_github_app %} you want to suspend.
![App selection](/assets/images/github-apps/github_apps_select-app.png)
{% data reusables.user-settings.github_apps_advanced %}
6. Next to the suspension settings for the installation, click **Suspend** or **Unsuspend**.