GitHub Apps "beta features" are now "optional features" (#17640)
Co-authored-by: Lucas Costi <lucascosti@users.noreply.github.com>
This commit is contained in:
Sarah Edwards
|
Before Width: | Height: | Size: 1.8 KiB After Width: | Height: | Size: 1.8 KiB |
BIN
assets/images/github-apps/optional-features-option.png
Normal file
BIN
assets/images/github-apps/optional-features-option.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 44 KiB |
@@ -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 %}
|
||||
@@ -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 %}
|
||||
@@ -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
|
||||
{
|
||||
|
||||
@@ -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 %}
|
||||
|
||||
@@ -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 %}.
|
||||
|
||||
5. In the left sidebar, click **Beta Features**.
|
||||
|
||||
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" %}  {% else %}  {% 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
|
||||
|
||||
@@ -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.
|
||||
|
||||
{% data reusables.user-settings.github_apps_advanced %}
|
||||
6. Next to the suspension settings for the installation, click **Suspend** or **Unsuspend**.
|
||||
|
||||
@@ -430,14 +430,6 @@ Key | Type | Description
|
||||
|
||||
{% endnote %}
|
||||
|
||||
{% if currentVersion == "free-pro-team@latest" %}
|
||||
{% note %}
|
||||
|
||||
**Note:** {% data reusables.pre-release-program.suspend-installation-beta %} For more information, see "[Suspending a {% data variables.product.prodname_github_app %} installation](/apps/managing-github-apps/suspending-a-github-app-installation/)."
|
||||
|
||||
{% endnote %}
|
||||
{% endif %}
|
||||
|
||||
#### Availability
|
||||
|
||||
- {% data variables.product.prodname_github_app %}s
|
||||
|
||||
@@ -1,4 +0,0 @@
|
||||
4. In the left sidebar, click **Beta Features**.
|
||||
|
||||
5. Next to the beta feature you want to enable for your app, click **Opt-in**.
|
||||
|
||||
4
data/reusables/apps/optional_feature_activation.md
Normal file
4
data/reusables/apps/optional_feature_activation.md
Normal file
@@ -0,0 +1,4 @@
|
||||
4. 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" %}  {% else %}  {% endif %}
|
||||
5. Next to the {% if currentVersion ver_lt "enterprise-server@3.1" %} beta {% else %} optional {% endif %} feature you want to enable for your app, click **Opt-in**.
|
||||
|
||||
@@ -1,7 +0,0 @@
|
||||
{% if currentVersion == "free-pro-team@latest" %}
|
||||
{% note %}
|
||||
|
||||
**Note:** 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)." For more information, see "[Expiring user-to-server access tokens for GitHub Apps](https://developer.github.com/changes/2020-04-30-expiring-user-to-server-access-tokens-for-github-apps)."
|
||||
|
||||
{% endnote %}
|
||||
{% endif %}
|
||||
@@ -0,0 +1,16 @@
|
||||
{% if currentVersion ver_gt "enterprise-server@2.1" and currentVersion ver_lt "enterprise-server@3.1" %}
|
||||
{% note %}
|
||||
|
||||
**Note:** 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 optional features for apps](/developers/apps/activating-optional-features-for-apps)." For more information, see "[Expiring user-to-server access tokens for GitHub Apps](https://developer.github.com/changes/2020-04-30-expiring-user-to-server-access-tokens-for-github-apps)."
|
||||
|
||||
{% endnote %}
|
||||
|
||||
{% else if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" or currentVersion == "github-ae@latest" %}
|
||||
|
||||
{% note %}
|
||||
|
||||
**Note:** Expiring user tokens are currently an optional feature and subject to change. To opt in or out of the user-to-server token expiration feature, see "[Activating optional features for apps](/developers/apps/activating-optional-features-for-apps)." For more information, see "[Expiring user-to-server access tokens for GitHub Apps](https://developer.github.com/changes/2020-04-30-expiring-user-to-server-access-tokens-for-github-apps)."
|
||||
|
||||
{% endnote %}
|
||||
|
||||
{% endif %}
|
||||
@@ -1 +0,0 @@
|
||||
Suspending a {% data variables.product.prodname_github_app %} installation is currently in beta and subject to change. Before you can suspend a {% data variables.product.prodname_github_app %}, the app owner must enable suspending installations for the app by opting-in to the beta. To opt-in to the suspending installations beta feature, see "[Activating beta features for apps](/developers/apps/activating-beta-features-for-apps)."
|
||||
Reference in New Issue
Block a user