Skip to main content
我们经常发布文档更新，此页面的翻译可能仍在进行中。 有关最新信息，请访问英语文档。
All products
“应用”

Modifying a GitHub App registration

本文内容

创建 GitHub App 后，可以对其进行更改。

About GitHub App modifications

You can modify your GitHub App registration to change any of the settings that were selected when the app was initially registered. For more information about the settings you can select while registering a GitHub App, see "Registering a GitHub App."

For example, you can change the name and description of your app, the permissions granted to your app, the webhooks your app subscribes to, or the visibility of your app.

You can also choose to test new optional features for your GitHub App. For more information, see "激活 GitHub 应用的可选功能."

To modify a GitHub App, first navigate to the app settings page.

  1. 导航到您的帐户设置。

    • 对于个人帐户拥有的 GitHub App，在任何页面的右上角，单击你的个人资料照片，然后单击“设置”。
    • 对于组织拥有的 GitHub App，在任何页面的右上角，单击你的个人资料照片，然后单击你的组织。 然后，在组织右侧，单击“设置”。

  2. 在左侧边栏中，单击“ 开发人员设置”。

  3. 在左侧边栏中，单击“GitHub App”。 GitHub 中“开发人员设置”页面的屏幕截图。 一个标有“GitHub 应用”的选项，以深橙色框出。

  4. 在要修改的 GitHub App 右边，单击“编辑”。

Changing the basic information of a GitHub App

You can change the basic information of your GitHub App, like the name of the app, the description of the app, and the homepage URL of the app.

  1. 导航到要修改的应用的设置页面。 有关详细信息，请参阅本文中的“导航到 GitHub App 设置”。
  2. Under "Basic information," modify the GitHub App information that you'd like to change.
  3. Click Save changes.

Requesting user authorization (OAuth) during installation

You can prompt users to authorize your GitHub App when they install it and generate a user access token. When you request user authorization (OAuth) during installation, you must also provide a callback URL where the user will be redirected after they authorize the installation. For more information, see "为 GitHub 应用生成用户访问令牌."

  1. 导航到要修改的应用的设置页面。 有关详细信息，请参阅本文中的“导航到 GitHub App 设置”。
  2. Under "Identifying and authorizing users," select or deselect Request user authorization (OAuth) during installation.
  3. Under "Callback URL," enter the full URL to redirect to after a user authorizes the installation.

Enabling or disabling the device flow

You can use the device flow to authorize users for a headless app like a CLI tool or Git credential manager. For more information about using the device flow with GitHub Apps, see "为 GitHub 应用生成用户访问令牌."

  1. 导航到要修改的应用的设置页面。 有关详细信息，请参阅本文中的“导航到 GitHub App 设置”。
  2. Under "Identifying and authorizing users," select or deselect Enable Device Flow.

Adding or updating a setup URL

You can redirect people to a specific URL after they install your app. For more information, see "Registering a GitHub App."

If you select Request user authorization (OAuth) during installation, you will not be able to enter a setup URL. Users will instead be redirected to the Callback URL as part of the authorization flow, where you can describe additional setup. For more information, see "About the user authorization callback URL."

  1. 导航到要修改的应用的设置页面。 有关详细信息，请参阅本文中的“导航到 GitHub App 设置”。
  2. Under "Post installation," in the "Setup URL" field, enter the URL where you'd like to redirect users after they install your app.
  3. Optionally, if you want to redirect users to the setup URL after they update an installation, select Redirect on update. An update includes adding or removing a repository for an installation. If "Setup URL" is blank, this will be ignored.

Changing the permissions of a GitHub App

You can change the access permissions that are granted to your GitHub App using the following steps.

When you change the repository or organization permissions of an app, each account where the app is installed will need to approve the new permissions. When you change the account permissions of an app, each user that has authorized the app will need to approve the permission changes. Updated permissions won't take effect on an installation or user authorization until the new permissions are approved. You can use the installation webhook to find out when people accept new permissions for your app.

Changing the permissions of an app may also change the webhooks that your app can subscribe to and the actions that your app can take with the API. For more information, see "Choosing permissions for a GitHub App."

  1. 导航到要修改的应用的设置页面。 有关详细信息，请参阅本文中的“导航到 GitHub App 设置”。
  2. In the GitHub Apps settings sidebar, click Permissions & events.
  3. Under the sections "Repository permissions," "Organization permissions," and "Account permissions," modify the permissions you'd like to change. For each type of permission, select either "Read-only," "Read and write," or "No access" from the dropdown. For more information, see "Choosing permissions for a GitHub App."
  4. Optionally, under "Add a note to users," add a note telling your users why you are changing the permissions that your GitHub App requests.
  5. Click Save changes.

Activating or deactivating the GitHub App webhook

You can configure your GitHub App to receive webhooks for specific events on GitHub and automatically take action on them. For more information, see "Using webhooks with GitHub Apps."

  1. 导航到要修改的应用的设置页面。 有关详细信息，请参阅本文中的“导航到 GitHub App 设置”。
  2. Under "Webhook," to enable or disable the webhook, select or deselect Active.
  3. If you selected Active in the previous step, under "Webhook URL," enter the URL that GitHub should send webhook events to.
  4. Optionally, if you selected Active in the previous step, under "Webhook secret," enter a secret token to secure your webhooks. GitHub highly recommends that you set a webhook secret.

Changing the webhook event subscriptions of a GitHub App

You can change the webhook events that a GitHub App subscribes to using the following steps.

可以在应用设置中选择的具体 Webhook 事件根据为应用选择的权限类型而定。 首先需要选择希望应用拥有的权限，然后可以让应用订阅与该权限集相关的 Webhook 事件。 For more information, see "Using webhooks with GitHub Apps."

  1. 导航到要修改的应用的设置页面。 有关详细信息，请参阅本文中的“导航到 GitHub App 设置”。
  2. Activate the GitHub App webhook. For more information, see "Activating or deactivating the GitHub App webhook" in this article.
  3. In the GitHub Apps settings sidebar, click Permissions & events.
  4. Under the sections "Repository permissions," "Organization permissions," and "Account permissions," select the permissions that are required for the events your app will subscribe to. For more information, see "Changing the permissions of a GitHub App."
  5. Under "Subscribe to Events," select the webhook events you would like your GitHub App to receive.
  6. Click Save changes.

Changing the visibility of a GitHub App

You can change the visibility settings of your GitHub App to control who can install it. Public apps cannot be made private if they're installed on other accounts. For more information, see "Making a GitHub App public or private."

  1. 导航到要修改的应用的设置页面。 有关详细信息，请参阅本文中的“导航到 GitHub App 设置”。
  2. 在左侧边栏中，单击“高级”。
  3. Under "Danger zone," depending on the current visibility of your GitHub App, click either Make public or Make private.