Skip to content

AutoCorrect fix for translations/zh-CN/content/developers #20838

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
huacnlee wants to merge 1 commit into from
Closed

AutoCorrect fix for translations/zh-CN/content/developers #20838

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions ...lopers/apps/building-github-apps/creating-a-custom-badge-for-your-github-app.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,9 @@ ms.locfileid: '145099209'

![默认肖像](/assets/images/identicon.png)

创建 GitHub 应用程序后，可以通过上传徽标和选择背景颜色自定义应用程序的徽章。 徽章是圆形徽章内的方形徽标图像。 您可以为徽章选择背景颜色，以便从视觉上与应用程序区分开。
创建 GitHub 应用程序后，可以通过上传徽标和选择背景颜色自定义应用程序的徽章。徽章是圆形徽章内的方形徽标图像。您可以为徽章选择背景颜色，以便从视觉上与应用程序区分开。

徽标应为 1 MB 以下的 PNG、JPG 或 GIF 文件。 为获得最佳渲染效果，建议图像大小至少为 200px x 200px。 {% ifversion fpt or ghec %}有关自定义徽章的详细指南，请参阅“[徽标和徽章图像的提示](/marketplace/listing-on-github-marketplace/writing-github-marketplace-listing-descriptions/#guidelines-for-logos)”。{% endif %}
徽标应为 1 MB 以下的 PNG、JPG 或 GIF 文件。为获得最佳渲染效果，建议图像大小至少为 200px x 200px。 {% ifversion fpt or ghec %}有关自定义徽章的详细指南，请参阅“[徽标和徽章图像的提示](/marketplace/listing-on-github-marketplace/writing-github-marketplace-listing-descriptions/#guidelines-for-logos)”。{% endif %}

{% ifversion fpt or ghec %}

Expand All @@ -39,7 +39,7 @@ ms.locfileid: '145099209'
{% data reusables.user-settings.access_settings %} {% data reusables.user-settings.developer_settings %} {% data reusables.user-settings.github_apps %} {% data reusables.user-settings.modify_github_app %}
5. 在“显示信息”中，从本地文件夹拖放图像，或单击“上传徽标”，从计算机选择图像。
![上传徽标](/assets/images/github-apps/github_apps_upload_logo.png)
6. 裁剪图片。 完成后，单击“设置新头像”。
6. 裁剪图片。完成后，单击“设置新头像”。
![裁剪和设置徽标](/assets/images/github-apps/github_apps_crop_and_set_avatar.png)
7. 在“徽章背景色”中，键入徽章背景色的[十六进制颜色代码](http://www.color-hex.com/)。 {% ifversion fpt or ghec %}注意：“徽章背景色”输入字段只会在上传应用程序徽标后显示。{% endif %} ![徽章背景色](/assets/images/github-apps/github_apps_badge_background_color.png)

Expand Down
36 changes: 18 additions & 18 deletions ...t/developers/apps/building-github-apps/creating-a-github-app-from-a-manifest.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: 从清单创建 GitHub 应用程序
intro: GitHub 应用程序清单是预先配置的 GitHub 应用程序，您可以与希望在其个人仓库中使用您的应用程序的任何用户分享它。 清单流程允许用户快速创建、安装和开始扩展 GitHub 应用程序，而无需注册应用程序或将注册连接到托管应用代码。
intro: GitHub 应用程序清单是预先配置的 GitHub 应用程序，您可以与希望在其个人仓库中使用您的应用程序的任何用户分享它。清单流程允许用户快速创建、安装和开始扩展 GitHub 应用程序，而无需注册应用程序或将注册连接到托管应用代码。
redirect_from:
- /apps/building-github-apps/creating-github-apps-from-a-manifest
- /developers/apps/creating-a-github-app-from-a-manifest
Expand All @@ -21,9 +21,9 @@ ms.locfileid: '145099208'
---
## 关于 GitHub 应用程序清单

当有人从清单创建 GitHub 应用程序时，他们只需遵循 URL 并命名应用程序即可。 清单包括自动注册应用程序所需的权限、事件和 web 挂钩 URL。 清单流程创建 GitHub 应用程序注册并检索应用程序的 web 挂钩密钥、私钥 （PEM 文件） 和 GitHub 应用程序 ID。 从清单创建应用的人将拥有该应用，并可以选择[编辑应用的配置设置](/apps/managing-github-apps/modifying-a-github-app/)、删除它或将其转让给 GitHub 上的其他人。
当有人从清单创建 GitHub 应用程序时，他们只需遵循 URL 并命名应用程序即可。清单包括自动注册应用程序所需的权限、事件和 web 挂钩 URL。清单流程创建 GitHub 应用程序注册并检索应用程序的 web 挂钩密钥、私钥（PEM 文件）和 GitHub 应用程序 ID。从清单创建应用的人将拥有该应用，并可以选择[编辑应用的配置设置](/apps/managing-github-apps/modifying-a-github-app/)、删除它或将其转让给 GitHub 上的其他人。

可以使用 [Probot](https://probot.github.io/) 开始使用 GitHub 应用清单或查看示例实现。 有关详细信息，请参阅“[使用 Probot 实现 GitHub 应用清单流](#using-probot-to-implement-the-github-app-manifest-flow)”。
可以使用 [Probot](https://probot.github.io/) 开始使用 GitHub 应用清单或查看示例实现。有关详细信息，请参阅“[使用 Probot 实现 GitHub 应用清单流](#using-probot-to-implement-the-github-app-manifest-flow)”。

以下是您可以使用 GitHub 应用程序清单来创建预配置应用程序的一些场景：

Expand All @@ -35,7 +35,7 @@ ms.locfileid: '145099208'

## 实现 GitHub 应用程序清单流程

GitHub 应用清单流使用类似于 [OAuth 流](/apps/building-oauth-apps/authorizing-oauth-apps/)的握手过程。 该流使用清单[注册 GitHub 应用](/apps/building-github-apps/creating-a-github-app/)，并接收用于检索该应用的私钥、Webhook 机密和 ID 的临时 `code`。
GitHub 应用清单流使用类似于 [OAuth 流](/apps/building-oauth-apps/authorizing-oauth-apps/)的握手过程。该流使用清单[注册 GitHub 应用](/apps/building-github-apps/creating-a-github-app/)，并接收用于检索该应用的私钥、Webhook 机密和 ID 的临时 `code`。

{% note %}

Expand All @@ -53,9 +53,9 @@ GitHub 应用清单流使用类似于 [OAuth 流](/apps/building-oauth-apps/auth

若要重定向人员以创建新的 GitHub 应用，请为他们[提供一个链接](#examples)以供单击，该链接针对个人帐户将 `POST` 请求发送到 `https://github.com/settings/apps/new`，或针对组织帐户将该请求发送到 `https://github.com/organizations/ORGANIZATION/settings/apps/new`，并将 `ORGANIZATION` 替换为将创建应用的组织帐户的名称。

必须将 [GitHub 应用清单参数](#github-app-manifest-parameters)作为 JSON 编码的字符串包含在名为 `manifest` 的参数中。 还可以包含一个 `state` [参数](#parameters)以实现额外的安全性。
必须将 [GitHub 应用清单参数](#github-app-manifest-parameters)作为 JSON 编码的字符串包含在名为 `manifest` 的参数中。还可以包含一个 `state` [参数](#parameters)以实现额外的安全性。

创建应用的人将被重定向到带有输入字段的 GitHub 页面，他们可以在该页面编辑你包含在 `manifest` 参数中的应用的名称。 如果你未在 `manifest` 中包含 `name`，他们可以在此字段中为应用设置自己的名称。
创建应用的人将被重定向到带有输入字段的 GitHub 页面，他们可以在该页面编辑你包含在 `manifest` 参数中的应用的名称。如果你未在 `manifest` 中包含 `name`，他们可以在此字段中为应用设置自己的名称。

![创建 GitHub 应用程序清单](/assets/images/github-apps/create-github-app-manifest.png)

Expand All @@ -67,11 +67,11 @@ GitHub 应用清单流使用类似于 [OAuth 流](/apps/building-oauth-apps/auth
`url` | `string` | **必填。** GitHub 应用的主页。
`hook_attributes` | `object` | GitHub 应用程序 web 挂钩的配置
`redirect_url` | `string` | 用户从清单启动 GitHub 应用创建后要重定向到的完整 URL。
`callback_urls` | `array of strings` | 在用户授权安装后重定向到的完整 URL。 您可以提供最多 10 个回叫 URL。
`callback_urls` | `array of strings` | 在用户授权安装后重定向到的完整 URL。您可以提供最多 10 个回叫 URL。
`description` | `string` | GitHub 应用程序的说明。
`public` | `boolean` | 当 GitHub 应用可供公众使用时，设置为 `true`；当其仅可供应用所有者访问时，设置为 `false`。
`default_events` | `array` | GitHub 应用订阅的[事件](/webhooks/event-payloads)列表。
`default_permissions` | `object` | GitHub 应用所需的[权限](/rest/reference/permissions-required-for-github-apps)集。 对象的格式使用键的权限名称（例如 `issues`）和值的访问类型（例如 `write`）。
`default_permissions` | `object` | GitHub 应用所需的[权限](/rest/reference/permissions-required-for-github-apps)集。对象的格式使用键的权限名称（例如 `issues`）和值的访问类型（例如 `write`）。

`hook_attributes` 对象具有以下键：

Expand Down Expand Up @@ -123,7 +123,7 @@ GitHub 应用清单流使用类似于 [OAuth 流](/apps/building-oauth-apps/auth
</script>
```

此示例使用网页上的表单，其中包含一个按钮，该按钮可触发组织帐户的 `POST` 请求。 将 `ORGANIZATION` 替换为要在其中创建应用的组织帐户的名称。
此示例使用网页上的表单，其中包含一个按钮，该按钮可触发组织帐户的 `POST` 请求。将 `ORGANIZATION` 替换为要在其中创建应用的组织帐户的名称。

```html
<form action="https://github.com/organizations/ORGANIZATION/settings/apps/new?state=abc123" method="post">
Expand Down Expand Up @@ -160,47 +160,47 @@ GitHub 应用清单流使用类似于 [OAuth 流](/apps/building-oauth-apps/auth

### 2. GitHub 将人员重定向回你的站点

当人员单击“创建 GitHub 应用”时，GitHub 会重定向回 `redirect_url`，其中，代码参数中包含临时 `code`。 例如：
当人员单击“创建 GitHub 应用”时，GitHub 会重定向回 `redirect_url`，其中，代码参数中包含临时 `code`。例如：

https://example.com/redirect?code=a180b1a3d263c81bc6441d7b990bae27d4c10679

如果提供了 `state` 参数，则还将在 `redirect_url` 中看到该参数。 例如：
如果提供了 `state` 参数，则还将在 `redirect_url` 中看到该参数。例如：

https://example.com/redirect?code=a180b1a3d263c81bc6441d7b990bae27d4c10679&state=abc123

### 3. 交换临时代码以检索应用配置

若要完成握手，请将 `POST` 请求中的临时 `code` 发送到[从清单创建 GitHub 应用](/rest/reference/apps#create-a-github-app-from-a-manifest)终结点。 响应将包括 `id`（GitHub 应用 ID）、`pem`（私钥）和 `webhook_secret`。 GitHub 会自动为应用程序创建一个 web 挂钩密钥。 您可以将这些值存储在应用程序服务器上的环境变量中。 例如，如果应用使用 [dotenv](https://github.com/bkeepers/dotenv) 来存储环境变量，则你应该将这些变量存储在应用的 `.env` 文件中。
若要完成握手，请将 `POST` 请求中的临时 `code` 发送到[从清单创建 GitHub 应用](/rest/reference/apps#create-a-github-app-from-a-manifest)终结点。响应将包括 `id`（GitHub 应用 ID）、`pem`（私钥）和 `webhook_secret`。GitHub 会自动为应用程序创建一个 web 挂钩密钥。您可以将这些值存储在应用程序服务器上的环境变量中。例如，如果应用使用 [dotenv](https://github.com/bkeepers/dotenv) 来存储环境变量，则你应该将这些变量存储在应用的 `.env` 文件中。

您必须在一小时内完成 GitHub 应用程序清单流程中的此步骤。

{% note %}

注意：此终结点具有速率限制。 请参阅[速率限制](/rest/reference/rate-limit)，了解如何获取当前速率限制状态。
注意：此终结点具有速率限制。请参阅[速率限制](/rest/reference/rate-limit)，了解如何获取当前速率限制状态。

{% endnote %}

POST /app-manifests/{code}/conversions

有关终结点响应的详细信息，请参阅[从清单创建 GitHub 应用](/rest/reference/apps#create-a-github-app-from-a-manifest)。

清单流程的最后一步完成后，从流程创建应用程序的人将是注册 GitHub 应用程序的所有者，他们可以将其安装到他们的任何个人仓库中。 他们可以选择使用 GitHub API 扩展应用程序、将所有权转让给其他人或者随时删除它。
清单流程的最后一步完成后，从流程创建应用程序的人将是注册 GitHub 应用程序的所有者，他们可以将其安装到他们的任何个人仓库中。他们可以选择使用 GitHub API 扩展应用程序、将所有权转让给其他人或者随时删除它。

## 使用 Probot 实现 GitHub 应用程序清单流程

[Probot](https://probot.github.io/) 是一种使用 [Node.js](https://nodejs.org/) 构建的框架，可执行所有 GitHub 应用所需的很多任务，例如验证 Webhook 和执行身份验证。 Probot 实现了 [GitHub 应用清单流](#implementing-the-github-app-manifest-flow)，使人们能够轻松创建 GitHub 应用参考设计并与 GitHub 社区共享。
[Probot](https://probot.github.io/) 是一种使用 [Node.js](https://nodejs.org/) 构建的框架，可执行所有 GitHub 应用所需的很多任务，例如验证 Webhook 和执行身份验证。Probot 实现了 [GitHub 应用清单流](#implementing-the-github-app-manifest-flow)，使人们能够轻松创建 GitHub 应用参考设计并与 GitHub 社区共享。

要创建可以分享的 Probot 应用程序，请遵循以下步骤：

1. [生成新的 GitHub 应用](https://probot.github.io/docs/development/#generating-a-new-app)。
1. 打开你创建的项目，自定义 `app.yml` 文件中的设置。 Probot 使用 `app.yml` 中的设置作为 [GitHub 应用清单参数](#github-app-manifest-parameters)。
1. 打开你创建的项目，自定义 `app.yml` 文件中的设置。Probot 使用 `app.yml` 中的设置作为 [GitHub 应用清单参数](#github-app-manifest-parameters)。
1. 添加应用程序的自定义代码。
1. [在本地运行 GitHub 应用](https://probot.github.io/docs/development/#running-the-app-locally)，或[将其托管到你想要的任何位置](#hosting-your-app-with-glitch)。 导航到托管应用的 URL 时，你会发现一个包含“注册 GitHub 应用”按钮的网页，人们可以单击该按钮创建预配置的应用。 下面的网页是 Probot 对 GitHub 应用清单流中的[步骤 1](#1-you-redirect-people-to-github-to-create-a-new-github-app) 的实现：
1. [在本地运行 GitHub 应用](https://probot.github.io/docs/development/#running-the-app-locally)，或[将其托管到你想要的任何位置](#hosting-your-app-with-glitch)。导航到托管应用的 URL 时，你会发现一个包含“注册 GitHub 应用”按钮的网页，人们可以单击该按钮创建预配置的应用。下面的网页是 Probot 对 GitHub 应用清单流中的[步骤 1](#1-you-redirect-people-to-github-to-create-a-new-github-app) 的实现：

![注册 Probot GitHub 应用程序](/assets/images/github-apps/github_apps_probot-registration.png)

Probot 使用 [dotenv](https://github.com/bkeepers/dotenv) 创建一个 `.env` 文件，并使用[从应用配置中检索的](#3-you-exchange-the-temporary-code-to-retrieve-the-app-configuration)值设置 `APP_ID`、`PRIVATE_KEY` 和 `WEBHOOK_SECRET` 环境变量。

### 使用 Glitch 托管应用程序

可以看到一个[示例 Probot 应用](https://glitch.com/~auspicious-aardwolf)，该应用使用 [Glitch](https://glitch.com/) 来托管和共享应用。 该示例使用[检查 API](/rest/reference/checks)，并选择 `app.yml` 文件中必要的检查 API 事件和权限。 Glitch 是一个允许您“重新组合自己的”应用程序的工具。 重新组合应用程序将创建一个 Glitch 托管和部署的应用程序副本。 请参阅“[关于 Glitch](https://glitch.com/about/)”，了解如何重新组合 Glitch 应用。
可以看到一个[示例 Probot 应用](https://glitch.com/~auspicious-aardwolf)，该应用使用 [Glitch](https://glitch.com/) 来托管和共享应用。该示例使用[检查 API](/rest/reference/checks)，并选择 `app.yml` 文件中必要的检查 API 事件和权限。Glitch 是一个允许您“重新组合自己的”应用程序的工具。重新组合应用程序将创建一个 Glitch 托管和部署的应用程序副本。请参阅“[关于 Glitch](https://glitch.com/about/)”，了解如何重新组合 Glitch 应用。
Loading