Skip to content

Commit aefb091

Browse files
Sarah Edwardslucascosti
Sarah Edwards
and
lucascosti
authored
GitHub Apps "beta features" are now "optional features" (#17640)
Co-authored-by: Lucas Costi <lucascosti@users.noreply.github.com>
1 parent 5c0cf9a commit aefb091

14 files changed

Lines changed: 60 additions & 64 deletions

assets/images/github-apps/enable-beta-features.png renamed to assets/images/github-apps/enable-optional-features.png

File renamed without changes.

‎assets/images/github-apps/optional-features-option.png‎

44.5 KB
Loading

‎content/developers/apps/activating-beta-features-for-apps.md‎

Lines changed: 0 additions & 28 deletions
This file was deleted.

‎content/developers/apps/activating-optional-features-for-apps.md‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
---
2+
title: Activating optional features for apps
3+
intro: 'You can test new optional features for your {% data variables.product.prodname_github_apps %} and {% data variables.product.prodname_oauth_app %}s.'
4+
redirect_from:
5+
- /developers/apps/activating-beta-features-for-apps
6+
versions:
7+
free-pro-team: '*'
8+
github-ae: '*'
9+
enterprise-server: '>=2.22'
10+
---
11+
12+
{% warning %}
13+
14+
**Warning:** {% if currentVersion ver_lt "enterprise-server@3.1" %} Beta {% else %} Optional {% endif %} features are subject to change.
15+
16+
{% endwarning %}
17+
18+
### Activating {% if currentVersion ver_lt "enterprise-server@3.1" %} beta {% else %} optional {% endif %} features for {% data variables.product.prodname_github_apps %}
19+
20+
{% data reusables.user-settings.access_settings %}
21+
{% data reusables.user-settings.developer_settings %}
22+
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.
23+
{% data reusables.apps.optional_feature_activation %}
24+
25+
### Activating {% if currentVersion ver_lt "enterprise-server@3.1" %} beta {% else %} optional {% endif %} features for {% data variables.product.prodname_oauth_app %}s
26+
27+
{% data reusables.user-settings.access_settings %}
28+
{% data reusables.user-settings.developer_settings %}
29+
{% data reusables.user-settings.oauth_apps %}
30+
{% data reusables.apps.optional_feature_activation %}

‎content/developers/apps/identifying-and-authorizing-users-for-github-apps.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ versions:
1212
---
1313

1414

15-
{% data reusables.pre-release-program.expiring-user-access-tokens-beta %}
15+
{% data reusables.pre-release-program.expiring-user-access-tokens %}
1616

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

@@ -67,9 +67,9 @@ If the user accepts your request, GitHub redirects back to your site with a temp
6767

6868
{% endnote %}
6969

70-
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)."
70+
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)."
7171

72-
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 %}
72+
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 %}
7373

7474
POST {% data variables.product.oauth_host_code %}/login/oauth/access_token
7575

@@ -87,7 +87,7 @@ Name | Type | Description
8787

8888
{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" or currentVersion == "github-ae@latest" %}
8989

90-
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.
90+
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.
9191

9292
```json
9393
{

‎content/developers/apps/index.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ versions:
1717

1818
{% topic_link_in_list /getting-started-with-apps %}
1919
{% link_in_list /about-apps %}
20-
{% link_in_list /activating-beta-features-for-apps %}
20+
{% link_in_list /activating-optional-features-for-apps %}
2121
{% link_in_list /differences-between-github-apps-and-oauth-apps %}
2222
{% link_in_list /migrating-oauth-apps-to-github-apps %}
2323
{% link_in_list /setting-up-your-development-environment-to-create-a-github-app %}

‎content/developers/apps/refreshing-user-to-server-access-tokens.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ versions:
1010
---
1111

1212

13-
{% data reusables.pre-release-program.expiring-user-access-tokens-beta %}
13+
{% data reusables.pre-release-program.expiring-user-access-tokens %}
1414

1515

1616
### About expiring user access tokens
@@ -57,8 +57,8 @@ You can enable or disable expiring user-to-server authorization tokens from your
5757
{% data reusables.user-settings.github_apps %}
5858
4. Click **Edit** next to your chosen {% data variables.product.prodname_github_app %}.
5959
![Settings to edit a GitHub App](/assets/images/github-apps/edit-test-app.png)
60-
5. In the left sidebar, click **Beta Features**.
61-
![Beta Features menu option](/assets/images/github-apps/beta-features-option.png)
60+
5. In the left sidebar, click **{% if currentVersion ver_lt "enterprise-server@3.1" %} Beta {% else %} Optional {% endif %} Features**.
61+
{% 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 %}
6262
6. Next to "User-to-server token expiration", click **Opt-in** or **Opt-out**. This setting may take a couple of seconds to apply.
6363

6464
### Opting out of expiring tokens for new GitHub Apps

‎content/developers/apps/suspending-a-github-app-installation.md‎

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -9,22 +9,16 @@ versions:
99
github-ae: '*'
1010
---
1111

12-
{% note %}
13-
14-
**Note:** {% data reusables.pre-release-program.suspend-installation-beta %}
15-
16-
{% endnote %}
17-
1812
### Suspending a GitHub App
1913

2014
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).
2115

22-
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/)."
16+
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.
2317

2418
{% data reusables.user-settings.access_settings %}
2519
{% data reusables.user-settings.developer_settings %}
2620
{% data reusables.user-settings.github_apps %}
27-
4. Select the {% data variables.product.prodname_github_app %} you want to suspend.
21+
1. Select the {% data variables.product.prodname_github_app %} you want to suspend.
2822
![App selection](/assets/images/github-apps/github_apps_select-app.png)
2923
{% data reusables.user-settings.github_apps_advanced %}
3024
6. Next to the suspension settings for the installation, click **Suspend** or **Unsuspend**.

‎content/developers/webhooks-and-events/webhook-events-and-payloads.md‎

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -430,14 +430,6 @@ Key | Type | Description
430430
431431
{% endnote %}
432432
433-
{% if currentVersion == "free-pro-team@latest" %}
434-
{% note %}
435-
436-
**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/)."
437-
438-
{% endnote %}
439-
{% endif %}
440-
441433
#### Availability
442434
443435
- {% data variables.product.prodname_github_app %}s

‎data/reusables/apps/beta_feature_activation.md‎

Lines changed: 0 additions & 4 deletions
This file was deleted.

0 commit comments

Comments
 (0)