Add 1.27 rc0 documentation (#453)

Reviewed-on: https://gitea.com/gitea/docs/pulls/453
Reviewed-by: Zettat123 <39446+zettat123@noreply.gitea.com>
This commit is contained in:
Lunny Xiao
2026-07-01 17:14:52 +00:00
parent 24fdff218d
commit 1033f033bc
328 changed files with 75235 additions and 275 deletions

View File

@@ -0,0 +1,9 @@
{
"label": "Repository",
"position": 10,
"link": {
"type": "generated-index",
"slug": "/usage/repository",
"description": "Repository management, Git operations, and content features"
}
}

View File

@@ -0,0 +1,18 @@
---
date: "2023-05-23T09:00:00+08:00"
slug: "clone-filters"
sidebar_position: 25
aliases:
- /zh-tw/clone-filters
---
# 克隆过滤器 (部分克隆)
Git 引入了 `--filter` 选项用于 `git clone` 命令,该选项可以过滤掉大文件和对象(如 blob从而创建一个仓库的部分克隆。克隆过滤器对于大型仓库和/或按流量计费的连接特别有用,因为完全克隆(不使用 `--filter`)可能会很昂贵(需要下载所有历史数据)。
这需要 Git 2.22 或更高版本,无论是在 Gitea 服务器上还是在客户端上都需要如此。为了使克隆过滤器正常工作,请确保客户端上的 Git 版本至少与服务器上的版本相同(或更高)。以管理员身份登录到 Gitea然后转到管理后台 -> 应用配置,查看服务器的 Git 版本。
默认情况下,克隆过滤器是启用的,除非在 `[git]` 下将 `DISABLE_PARTIAL_CLONE` 设置为 `true`
请参阅 [GitHub 博客文章:了解部分克隆](https://github.blog/2020-12-21-get-up-to-speed-with-partial-clone-and-shallow-clone/) 以获取克隆过滤器的常见用法(无 Blob 和无树的克隆),以及 [GitLab 部分克隆文档](https://docs.gitlab.com/ee/topics/git/partial_clone.html) 以获取更高级的用法(例如按文件大小过滤和取消过滤以将部分克隆转换为完全克隆)。

View File

@@ -0,0 +1,38 @@
---
date: "2023-05-23T09:00:00+08:00"
slug: "incoming-email"
sidebar_position: 13
aliases:
- /zh-tw/incoming-email
---
# 邮件接收
Gitea 支持通过接收邮件执行多种操作。本页面描述了如何进行设置。
## 要求
处理接收的电子邮件需要启用 IMAP 功能的电子邮件帐户。
推荐的策略是使用 [电子邮件子地址](https://en.wikipedia.org/wiki/Email_address#Sub-addressing),但也可以使用 catch-all 邮箱。
接收电子邮件地址中包含一个用户/操作特定的令牌,告诉 Gitea 应执行哪个操作。
此令牌应该出现在 `To``Delivered-To` 头字段中。
Gitea 会尝试检测自动回复并跳过它们,电子邮件服务器也应该配置以减少接收到的干扰(垃圾邮件、通讯订阅等)。
## 配置
要激活处理接收的电子邮件消息功能,您需要在配置文件中配置 `email.incoming` 部分。
`REPLY_TO_ADDRESS` 包含电子邮件客户端将要回复的地址。
该地址需要包含 `%{token}` 占位符,该占位符将被替换为描述用户/操作的令牌。
此占位符在地址中只能出现一次,并且必须位于地址的用户部分(`@` 之前)。
使用电子邮件子地址的示例可能如下:`incoming+%{token}@example.com`
如果使用 catch-all 邮箱,则占位符可以出现在地址的用户部分的任何位置:`incoming+%{token}@example.com``incoming_%{token}@example.com``%{token}@example.com`
## 安全性
在选择用于接收传入电子邮件的域时要小心。
建议在子域名上接收传入电子邮件,例如 `incoming.example.com`,以防止与运行在 `example.com` 上的其他服务可能存在的安全问题。

View File

@@ -0,0 +1,15 @@
---
date: "2023-05-23T09:00:00+08:00"
slug: "profile-readme"
sidebar_position: 12
---
# 个人资料 README
要在您的 Gitea 个人资料页面显示一个 Markdown 文件,只需创建一个名为 `.profile` 的仓库,并编辑其中的 `README.md` 文件。Gitea 将自动获取该文件并在您的仓库上方显示。
注意您可以将此仓库设为私有。这样可以隐藏您的源文件使其对公众不可见并允许您将某些文件设为私有。但是README.md 文件将是您个人资料上唯一存在的文件。如果您希望完全私有化 .profile 仓库,则需删除或重命名 README.md 文件。
用户示例 `.profile/README.md`:
![个人资料自述文件截图](/images/usage/profile-readme.png)

View File

@@ -0,0 +1,61 @@
---
date: "2023-05-23T09:00:00+08:00"
slug: "push"
sidebar_position: 15
aliases:
- /zh-tw/push-to-create
- /zh-tw/push-options
---
# 推送
在将提交推送到 Gitea 服务器时,还有一些额外的功能。
## 通过推送打开 PR
当您第一次将提交推送到非默认分支时,您将收到一个链接,您可以单击该链接访问分支与主分支的比较页面。
从那里,您可以轻松创建一个拉取请求,即使您想要将其目标指向另一个分支。
![Gitea 推送提示](/gitea-push-hint.png)
## 推送选项
在 Gitea `1.13` 版本中,添加了对一些 [推送选项](https://git-scm.com/docs/git-push#Documentation/git-push.txt--oltoptiongt) 的支持。
### 支持的选项
- `repo.private` (true|false) - 更改仓库的可见性。
这在与 push-to-create 结合使用时特别有用。
- `repo.template` (true|false) - 更改仓库是否为模板。
将仓库的可见性更改为公开的示例:
```shell
git push -o repo.private=false -u origin main
```
## 推送创建
推送创建是一项功能,允许您将提交推送到在 Gitea 中尚不存在的仓库。这对于自动化和允许用户创建仓库而无需通过 Web 界面非常有用。此功能默认处于禁用状态。
### 启用推送创建
`app.ini` 文件中,将 `ENABLE_PUSH_CREATE_USER` 设置为 `true`,如果您希望允许用户在自己的用户帐户和所属的组织中创建仓库,将 `ENABLE_PUSH_CREATE_ORG` 设置为 `true`。重新启动 Gitea 以使更改生效。您可以在 [配置速查表](../administration/config-cheat-sheet.md#仓库) 中了解有关这两个选项的更多信息。
### 使用推送创建
假设您在当前目录中有一个 git 仓库,您可以通过运行以下命令将提交推送到在 Gitea 中尚不存在的仓库:
```shell
# 添加要推送到的远程仓库
git remote add origin git@{domain}:{username}/{尚不存在的仓库名称}.git
# 推送到远程仓库
git push -u origin main
```
这假设您使用的是 SSH 远程,但您也可以使用 HTTPS 远程。
推送创建将默认使用 `app.ini` 中定义的可见性 `DEFAULT_PUSH_CREATE_PRIVATE`

View File

@@ -0,0 +1,98 @@
---
date: "2023-05-23T09:00:00+08:00"
slug: "repo-mirror"
sidebar_position: 45
aliases:
- /zh-tw/repo-mirror
---
# 仓库镜像
仓库镜像允许将仓库与外部源之间进行镜像。您可以使用它在仓库之间镜像分支、标签和提交。
## 使用场景
以下是一些仓库镜像的可能使用场景:
- 您迁移到了 Gitea但仍需要在其他源中保留您的项目。在这种情况下您可以简单地设置它以进行镜像到 Gitea拉取这样您的 Gitea 实例中就可以获取到所有必要的提交历史、标签和分支。
- 您在其他源中有一些旧项目,您不再主动使用,但出于归档目的不想删除。在这种情况下,您可以创建一个推送镜像,以便您的活跃的 Gitea 仓库可以将其更改推送到旧位置。
## 从远程仓库拉取
对于现有的远程仓库,您可以按照以下步骤设置拉取镜像:
1. 在右上角的“创建...”菜单中选择“迁移外部仓库”。
2. 选择远程仓库服务。
3. 输入仓库的 URL。
4. 如果仓库需要身份验证,请填写您的身份验证信息。
5. 选中“该仓库将是一个镜像”复选框。
6. 选择“迁移仓库”以保存配置。
现在,该仓库会定期从远程仓库进行镜像。您可以通过在仓库设置中选择“立即同步”来强制进行同步。
:::warning
:exclamation::exclamation: **注意:**您只能为尚不存在于您的实例上的仓库设置拉取镜像。一旦仓库创建成功,您就无法再将其转换为拉取镜像。:exclamation::exclamation:
:::
## 推送到远程仓库
对于现有的仓库,您可以按照以下步骤设置推送镜像:
1. 在仓库中,转到**设置** > **仓库**,然后进入**镜像设置**部分。
2. 输入一个仓库的 URL。
3. 如果仓库需要身份验证,请展开**授权**部分并填写您的身份验证信息。请注意,所请求的**密码**也可以是您的访问令牌。
4. 选择**添加推送镜像**以保存配置。
该仓库现在会定期镜像到远程仓库。您可以通过选择**立即同步**来强制同步。如果出现错误,会显示一条消息帮助您解决问题。
:::warning
:exclamation::exclamation: **注意:** 这将强制推送到远程仓库。这将覆盖远程仓库中的任何更改! :exclamation::exclamation:
:::
### 从 Gitea 向 GitHub 设置推送镜像
要从 Gitea 设置镜像到 GitHub您需要按照以下步骤进行操作
1. 创建一个具有选中 _public_repo_ 选项的 [GitHub 个人访问令牌](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token)。
2. 在 GitHub 上创建一个同名的仓库。与 Gitea 不同GitHub 不支持通过推送到远程来创建仓库。如果您的现有远程仓库与您的 Gitea 仓库具有相同的提交历史,您也可以使用现有的远程仓库。
3. 在您的 Gitea 仓库设置中,填写**Git 远程仓库 URL**`https://github.com/<your_github_group>/<your_github_project>.git`
4. 使用您的 GitHub 用户名填写**授权**字段,并将个人访问令牌作为**密码**。
5. (可选,适用于 Gitea 1.18+)选择`当推送新提交时同步`,这样一旦有更改,镜像将会及时更新。如果您愿意,您还可以禁用定期同步。
6. 选择**添加推送镜像**以保存配置。
仓库会很快进行推送。要强制推送,请选择**立即同步**按钮。
### 从 Gitea 向 GitLab 设置推送镜像
要从 Gitea 设置镜像到 GitLab您需要按照以下步骤进行操作
1. 创建具有 _write_repository_ 作用域的 [GitLab 个人访问令牌](https://docs.gitlab.com/ee/user/profile/personal_access_tokens.html)。
2. 填写**Git 远程仓库 URL**`https://<destination host>/<your_gitlab_group_or_name>/<your_gitlab_project>.git`
3. 在**授权**字段中填写 `oauth2` 作为**用户名**,并将您的 GitLab 个人访问令牌作为**密码**。
4. 选择**添加推送镜像**以保存配置。
仓库会很快进行推送。要强制推送,请选择**立即同步**按钮。
### 从 Gitea 向 Bitbucket 设置推送镜像
要从 Gitea 设置镜像到 Bitbucket您需要按照以下步骤进行操作
1. 创建一个具有选中 _Repository Write_ 选项的 [Bitbucket 应用密码](https://support.atlassian.com/bitbucket-cloud/docs/app-passwords/)。
2. 填写**Git 远程仓库 URL**`https://bitbucket.org/<your_bitbucket_group_or_name>/<your_bitbucket_project>.git`
3. 使用您的 Bitbucket 用户名填写**授权**字段,并将应用密码作为**密码**。
4. 选择**添加推送镜像**以保存配置。
仓库会很快进行推送。要强制推送,请选择**立即同步**按钮。
### 镜像现有的 ssh 仓库
当前Gitea 不支持从 ssh 仓库进行镜像。如果您想要镜像一个 ssh 仓库,您需要将其转换为 http 仓库。您可以使用以下命令将现有的 ssh 仓库转换为 http 仓库:
1. 确保运行 gitea 的用户有权限访问您试图从 shell 镜像到的 git 仓库。
2. 在 Web 界面的版本库设置 > git 钩子中为镜像添加一个接收后钩子。
```
#!/usr/bin/env bash
git push --mirror --quiet git@github.com:username/repository.git &>/dev/null &
echo "GitHub mirror initiated .."
```

View File

@@ -0,0 +1,76 @@
---
date: "2023-05-23T09:00:00+08:00"
slug: "template-repositories"
sidebar_position: 14
aliases:
- /zh-tw/template-repositories
---
# 模板仓库
Gitea `1.11.0` 及以上版本引入了模板仓库,并且其中一个实现的功能是自动展开模板文件中的特定变量。
要告诉 Gitea 哪些文件需要展开,您必须在模板仓库的 `.gitea` 目录中包含一个 `template` 文件。
Gitea 使用 [gobwas/glob](https://github.com/gobwas/glob) 作为其 glob 语法。它与传统的 `.gitignore` 语法非常相似,但可能存在细微的差异。
## `.gitea/template` 文件示例
所有路径都是相对于仓库的根目录
```gitignore
# 仓库中的所有 .go 文件
**.go
# text 目录中的所有文本文件
text/*.txt
# 特定文件
a/b/c/d.json
# 匹配批处理文件的大小写变体
**.[bB][aA][tT]
```
**注意:** 当从模板生成仓库时,`.gitea` 目录中的 `template` 文件将被删除。
## 参数展开
在与上述通配符匹配的任何文件中,将会扩展某些变量。
文件名和路径的匹配也可以被扩展,并且会经过谨慎的清理处理,以支持跨平台的文件系统。
所有变量都必须采用`$VAR``${VAR}`的形式。要转义扩展,使用双重`$$`,例如`$$VAR``$${VAR}`
| 变量 | 扩展为 | 可转换 |
| -------------------- | ----------------------------- | ------ |
| REPO_NAME | 生成的仓库名称 | ✓ |
| TEMPLATE_NAME | 模板仓库名称 | ✓ |
| REPO_DESCRIPTION | 生成的仓库描述 | ✘ |
| TEMPLATE_DESCRIPTION | 模板仓库描述 | ✘ |
| REPO_OWNER | 生成的仓库所有者 | ✓ |
| TEMPLATE_OWNER | 模板仓库所有者 | ✓ |
| REPO_LINK | 生成的仓库链接 | ✘ |
| TEMPLATE_LINK | 模板仓库链接 | ✘ |
| REPO_HTTPS_URL | 生成的仓库的 HTTP(S) 克隆链接 | ✘ |
| TEMPLATE_HTTPS_URL | 模板仓库的 HTTP(S) 克隆链接 | ✘ |
| REPO_SSH_URL | 生成的仓库的 SSH 克隆链接 | ✘ |
| TEMPLATE_SSH_URL | 模板仓库的 SSH 克隆链接 | ✘ |
## 转换器 :robot:
Gitea `1.12.0` 添加了一些转换器以应用于上述适用的变量。
例如,要以 `PASCAL`-case 获取 `REPO_NAME`,你的模板应使用 `${REPO_NAME_PASCAL}`
`go-sdk` 传递给可用的转换器的效果如下...
| 转换器 | 效果 |
| ------ | ------ |
| SNAKE | go_sdk |
| KEBAB | go-sdk |
| CAMEL | goSdk |
| PASCAL | GoSdk |
| LOWER | go-sdk |
| UPPER | GO-SDK |
| TITLE | Go-Sdk |

View File

@@ -0,0 +1,720 @@
---
date: "2016-12-01T16:00:00+02:00"
slug: "webhooks"
sidebar_position: 30
aliases:
- /zh-tw/webhooks
---
# Webhooks
Gitea 可以為儲存庫活動送出對外 Webhook。儲存庫層級的 Webhook 由儲存庫管理員
`/:username/:reponame/settings/hooks` 中設定。組織、使用者與系統管理層級
也有對應的 Webhook 設定頁面。
Webhook 設定支援四種範圍:
- `儲存庫 Webhook`:只會對單一儲存庫中的活動觸發。
- `組織 Webhook`:對該組織擁有的儲存庫中的活動觸發。
- `使用者 Webhook`:對該使用者擁有的儲存庫中的活動觸發。
- `系統 Webhook`:對實例中所有符合條件的活動觸發。
Gitea 也支援由管理員定義的 `預設 Webhook`。它並不是額外的投遞範圍,而是會在
建立新儲存庫時被複製到該儲存庫中,之後就會像一般儲存庫 Webhook 一樣運作。
Gitea 支援以下對外 Webhook 整合:
- Gitea
- Gogs
- Slack
- Discord
- Dingtalk
- Telegram
- Microsoft Teams
- Feishu
- Matrix
- Wechatwork
- Packagist
`Gitea``Gogs` 類型會送出通用 Webhook payload。上面列出的聊天與服務整合
則會把同一個內部事件轉換成各自服務所需的請求主體格式。
本頁分成三個部分:
- `設定`:如何設定 Webhook 選項,例如 URL、密鑰、分支過濾器與授權標頭。
- `投遞`Gitea 如何送出 Webhook 請求、會附帶哪些標頭,以及如何驗證投遞。
- `事件`Gitea 會投遞哪些事件,以及每個事件包含哪些頂層 payload 參數。
## 設定
本節介紹在建立或編輯 Webhook 時可以設定的選項。
### 設定 Webhook
建立 Webhook 時,主要設定項目包括:
- `Target URL`:接收投遞的目標位址。
- `HTTP Method`:通用 Webhook 通常使用 `POST`
- `POST Content Type`:通用 Webhook 可使用 `application/json`
`application/x-www-form-urlencoded`
- `Secret`:用來對原始請求主體進行 HMAC 簽章。
- `Authorization Header`:可選的自訂 `Authorization` 標頭,會隨每次請求送出。
- `Branch Filter`:可選的分支或標籤過濾規則。
- `Trigger On``Push Events``All Events` 或自訂事件選擇。
- `Active`:是否啟用該 Webhook。
:::note
舊版範例中可能仍會在 JSON payload 裡看到 `secret` 欄位。當前版本的 Gitea
不會再把 Webhook 密鑰放進 payload 內容中。請務必透過簽章標頭驗證請求。
:::
### 分支過濾器
分支過濾器使用與
[`github.com/gobwas/glob`](https://pkg.go.dev/github.com/gobwas/glob#Compile)
相容的 glob 語法。
- 空值、`*``**` 代表符合全部。
-`main` 這樣的一般分支名稱會符合該分支。
- 也支援 `refs/tags/v*` 這類完整 ref。
- 支援 `{main,release/*}` 這類大括號表達式。
- 過濾器只會套用在帶有 git ref 的事件,例如 `create``delete``push`
- 不帶 ref 的事件,例如 issue 或 release會忽略分支過濾器。
範例:
- `main`
- `{main,feature/*}`
- `{refs/heads/feature/*,refs/tags/release/*}`
### 授權標頭
Gitea 可以設定為在每次 Webhook 投遞時送出自訂的
[Authorization header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Authorization)。
它與 Webhook 密鑰彼此獨立:
- 使用密鑰透過 HMAC 驗證請求完整性。
- 當接收端需要應用層認證時,使用 `Authorization` 標頭。
## 投遞
本節說明 Gitea 如何送出 Webhook 投遞,以及接收端如何識別與驗證這些請求。
### 投遞行為
- Webhook 會透過 HTTP 非同步投遞。
- 通用 `Gitea``Gogs` Webhook 支援 `POST``GET`;通常應使用 `POST`
- 對於 `POST` 請求payload 可以直接以 JSON
`application/json`)送出,也可以放在名為 `payload` 的表單欄位中
`application/x-www-form-urlencoded`)。
- 某些特定服務整合可能會使用該服務要求的 HTTP 方法與請求主體格式。
### 投遞標頭
每次投遞都包含唯一的 delivery ID 與事件標頭。對於相容 GitHub 的整合,
Gitea 也會同時送出對應的 GitHub 與 Gogs 風格標頭。
| 標頭 | 說明 |
| --- | --- |
| `X-Gitea-Delivery` | 本次投遞嘗試的唯一 UUID。 |
| `X-Gitea-Event` | 規範化事件名稱,例如 `push``issues``pull_request`。 |
| `X-Gitea-Event-Type` | 更具體的事件類型,例如 `issue_assign``pull_request_review_comment`。 |
| `X-Gitea-Signature` | 原始請求主體的十六進位 HMAC-SHA256 值,不含前綴。 |
| `X-Gitea-Hook-Installation-Target-Type` | Webhook 定義所在範圍,通常是 `repository``organization``user``system`。預設 Webhook 會先複製到儲存庫後再投遞,因此通常會呈現為 `repository`。 |
| `X-Gogs-Delivery``X-Gogs-Event``X-Gogs-Event-Type``X-Gogs-Signature` | 與 Gitea 對應標頭值相同的相容性標頭。 |
| `X-GitHub-Delivery``X-GitHub-Event``X-GitHub-Event-Type` | GitHub 風格相容性標頭。 |
| `X-GitHub-Hook-Installation-Target-Type` | GitHub 風格的 Webhook 範圍標頭。 |
| `X-Hub-Signature` | GitHub 相容的 HMAC-SHA1 標頭,格式為 `sha1=<digest>`。 |
| `X-Hub-Signature-256` | GitHub 相容的 HMAC-SHA256 標頭,格式為 `sha256=<digest>`。 |
如果未設定密鑰,簽章標頭仍然會存在,但摘要值為空。
#### `Event` 與 `Event-Type`
某些 Gitea Webhook 訂閱會被歸類到同一個規範化事件名稱下。例如issue 指派
投遞會歸類到 issue 事件群組:
```http
X-Gitea-Event: issues
X-Gitea-Event-Type: issue_assign
X-GitHub-Event: issues
X-GitHub-Event-Type: issue_assign
```
如果你需要知道實際觸發投遞的具體事件類型,請使用 `X-Gitea-Event-Type`
#### 驗證投遞
Gitea 會使用你的 Webhook 密鑰對原始請求主體進行簽章。要驗證一次投遞:
1. 以接收到的原始內容讀取請求主體。
2. 使用 Webhook 密鑰計算 HMAC-SHA256 摘要。
3. 將結果與 `X-Gitea-Signature` 或 GitHub 相容的
`X-Hub-Signature-256` 進行比較。
4. 盡量使用常數時間比較函式。
注意事項:
- `X-Gitea-Signature` 只包含小寫十六進位的 SHA-256 摘要。
- `X-Hub-Signature-256` 使用相同摘要,但帶有 `sha256=` 前綴。
- `X-Hub-Signature` 也會為了相容性而送出,其演算法為 SHA-1。
- 在完成簽章驗證之前,不應先解析 JSON 或修改請求主體。
##### PHP 範例
下面的範例示範如何驗證以 `application/json` 送出的通用 `Gitea` Webhook。
```php
<?php
$secret = '123';
if ($_SERVER['REQUEST_METHOD'] !== 'POST') {
http_response_code(405);
exit('Only POST is allowed');
}
$payload = file_get_contents('php://input');
$signature = $_SERVER['HTTP_X_GITEA_SIGNATURE'] ?? '';
if ($payload === false || $signature === '') {
http_response_code(400);
exit('Missing payload or signature');
}
$expected = hash_hmac('sha256', $payload, $secret);
if (!hash_equals($expected, $signature)) {
http_response_code(401);
exit('Invalid signature');
}
$event = $_SERVER['HTTP_X_GITEA_EVENT'] ?? '';
$eventType = $_SERVER['HTTP_X_GITEA_EVENT_TYPE'] ?? '';
$data = json_decode($payload, true);
if (!is_array($data)) {
http_response_code(400);
exit('Invalid JSON payload');
}
http_response_code(204);
```
## 事件
本節採用與 GitHub Webhook 文件類似的逐事件描述方式:每個事件都會說明
觸發時機,以及 payload 中包含哪些頂層欄位。
事件分組與 Webhook 設定介面中的分組一致:`Repository Events`
`Issue Events``Pull Request Events``Workflow Events`
### 儲存庫事件
- `create``delete``fork``push``wiki``repository``release``package``status`
#### `create`
當分支或標籤被建立時,會觸發此事件。
##### Payload 參數
| 名稱 | 類型 | 說明 |
| --- | --- | --- |
| `sha` | `string` | **必填。** 新建引用對應的物件 ID。 |
| `ref` | `string` | **必填。** 被建立的分支名稱或標籤名稱。 |
| `ref_type` | `string` | **必填。** 引用類型,例如 `branch``tag`。 |
| `repository` | `object` | **必填。** 建立該引用的儲存庫。 |
| `sender` | `object` | **必填。** 建立該引用的使用者。 |
#### `delete`
當分支或標籤被刪除時,會觸發此事件。
##### Payload 參數
| 名稱 | 類型 | 說明 |
| --- | --- | --- |
| `ref` | `string` | **必填。** 被刪除的分支名稱或標籤名稱。 |
| `ref_type` | `string` | **必填。** 引用類型,例如 `branch``tag`。 |
| `pusher_type` | `string` | **必填。** 刪除該 ref 的行為主體類型。目前 Gitea payload 使用 `user`。 |
| `repository` | `object` | **必填。** 刪除該引用所在的儲存庫。 |
| `sender` | `object` | **必填。** 刪除該引用的使用者。 |
#### `fork`
當儲存庫被 fork 時,會觸發此事件。
##### Payload 參數
| 名稱 | 類型 | 說明 |
| --- | --- | --- |
| `forkee` | `object` | **必填。** 新建立的 fork 儲存庫。 |
| `repository` | `object` | **必填。** 被 fork 的原始儲存庫。 |
| `sender` | `object` | **必填。** 建立 fork 的使用者。 |
#### `push`
當提交被推送到某個分支或標籤時,會觸發此事件。
##### Payload 參數
| 名稱 | 類型 | 說明 |
| --- | --- | --- |
| `ref` | `string` | **必填。** 被推送的完整 ref例如 `refs/heads/main`。 |
| `before` | `string` | **必填。** 推送前的提交 SHA。 |
| `after` | `string` | **必填。** 推送後的提交 SHA。 |
| `compare_url` | `string` | **必填。** 用於比較 `before``after` 的 URL。 |
| `commits` | `array` | **必填。** 本次推送包含的提交清單。 |
| `total_commits` | `integer` | **必填。** 本次推送中的提交數量。 |
| `head_commit` | `object` | 本次推送中的最新提交。 |
| `repository` | `object` | **必填。** 接收此次推送的儲存庫。 |
| `pusher` | `object` | **必填。** 執行推送的使用者。 |
| `sender` | `object` | **必填。** 觸發 Webhook 的使用者。 |
#### `wiki`
當 Wiki 頁面被建立、編輯或刪除時,會觸發此事件。
**動作類型:** `created``edited``deleted`
##### Payload 參數
| 名稱 | 類型 | 說明 |
| --- | --- | --- |
| `action` | `string` | **必填。** Wiki 頁面操作類型。 |
| `repository` | `object` | **必填。** 擁有該 Wiki 的儲存庫。 |
| `sender` | `object` | **必填。** 修改 Wiki 頁面的使用者。 |
| `page` | `string` | **必填。** Wiki 頁面名稱。 |
| `comment` | `string` | Wiki 提交訊息或註解。 |
#### `repository`
當儲存庫被建立或刪除時,會觸發此事件。
**動作類型:** `created``deleted`
##### Payload 參數
| 名稱 | 類型 | 說明 |
| --- | --- | --- |
| `action` | `string` | **必填。** 儲存庫操作類型。 |
| `repository` | `object` | **必填。** 被建立或刪除的儲存庫。 |
| `organization` | `object` | 當儲存庫屬於某個組織時會出現。 |
| `sender` | `object` | **必填。** 執行該操作的使用者。 |
#### `release`
當發行版本被發佈、更新或刪除時,會觸發此事件。
**動作類型:** `published``updated``deleted`
##### Payload 參數
| 名稱 | 類型 | 說明 |
| --- | --- | --- |
| `action` | `string` | **必填。** Release 操作類型。 |
| `release` | `object` | **必填。** 被操作的發行版本。 |
| `repository` | `object` | **必填。** 包含該發行版本的儲存庫。 |
| `sender` | `object` | **必填。** 執行該操作的使用者。 |
#### `package`
當套件被建立或刪除時,會觸發此事件。
**動作類型:** `created``deleted`
##### Payload 參數
| 名稱 | 類型 | 說明 |
| --- | --- | --- |
| `action` | `string` | **必填。** 套件操作類型。 |
| `repository` | `object` | 與該套件關聯的儲存庫;如果適用則會出現。 |
| `package` | `object` | **必填。** 被操作的套件。 |
| `organization` | `object` | 當套件擁有者是組織時會出現。 |
| `sender` | `object` | **必填。** 執行該操作的使用者。 |
#### `status`
當透過 API 建立或更新提交狀態時,會觸發此事件。
##### Payload 參數
| 名稱 | 類型 | 說明 |
| --- | --- | --- |
| `commit` | `object` | 與該狀態關聯的提交。 |
| `context` | `string` | **必填。** 狀態內容,例如 `ci/build`。 |
| `created_at` | `string` | **必填。** 狀態建立時間。 |
| `description` | `string` | 狀態描述文字。 |
| `id` | `integer` | **必填。** 狀態識別碼。 |
| `repository` | `object` | **必填。** 包含該提交的儲存庫。 |
| `sender` | `object` | **必填。** 建立該狀態的使用者。 |
| `sha` | `string` | **必填。** 提交 SHA。 |
| `state` | `string` | **必填。** 狀態值,例如 `pending``success``error``failure`。 |
| `target_url` | `string` | 與該狀態關聯的目標 URL。 |
| `updated_at` | `string` | 狀態最後更新時間。 |
與多數其他 payload 不同,此事件不使用 `action` 欄位,狀態變化透過 `state`
欄位表示。
### 議題事件
- `issues``issue_assign``issue_label``issue_milestone``issue_comment`
#### `issues`
當 issue 被開啟、關閉、重新開啟、編輯或刪除時,會觸發此事件。
**動作類型:** `opened``closed``reopened``edited``deleted`
##### Payload 參數
| 名稱 | 類型 | 說明 |
| --- | --- | --- |
| `action` | `string` | **必填。** Issue 操作類型。 |
| `number` | `integer` | **必填。** Issue 編號。 |
| `changes` | `object` | 可選。編輯欄位之前的值,或標籤變更明細。 |
| `issue` | `object` | **必填。** 被操作的 issue。 |
| `repository` | `object` | **必填。** 包含該 issue 的儲存庫。 |
| `sender` | `object` | **必填。** 執行該操作的使用者。 |
| `commit_id` | `string` | 與該 issue 操作關聯的提交 SHA如果適用則會出現。 |
#### `issue_assign`
當 issue 被指派或取消指派時,會觸發此事件。
**動作類型:** `assigned``unassigned`
##### Payload 參數
| 名稱 | 類型 | 說明 |
| --- | --- | --- |
| `action` | `string` | **必填。** 指派操作類型。 |
| `number` | `integer` | **必填。** Issue 編號。 |
| `changes` | `object` | 可選。編輯欄位之前的值,或標籤變更明細。 |
| `issue` | `object` | **必填。** 被操作的 issue。 |
| `repository` | `object` | **必填。** 包含該 issue 的儲存庫。 |
| `sender` | `object` | **必填。** 執行該操作的使用者。 |
| `commit_id` | `string` | 與該 issue 操作關聯的提交 SHA如果適用則會出現。 |
#### `issue_label`
當 issue 標籤被更新或清空時,會觸發此事件。
**動作類型:** `label_updated``label_cleared`
##### Payload 參數
| 名稱 | 類型 | 說明 |
| --- | --- | --- |
| `action` | `string` | **必填。** 標籤更新操作類型。 |
| `number` | `integer` | **必填。** Issue 編號。 |
| `changes` | `object` | 可選。編輯欄位之前的值,或標籤變更明細。 |
| `issue` | `object` | **必填。** 被操作的 issue。 |
| `repository` | `object` | **必填。** 包含該 issue 的儲存庫。 |
| `sender` | `object` | **必填。** 執行該操作的使用者。 |
| `commit_id` | `string` | 與該 issue 操作關聯的提交 SHA如果適用則會出現。 |
#### `issue_milestone`
當 issue 被設定里程碑或移除里程碑時,會觸發此事件。
**動作類型:** `milestoned``demilestoned`
##### Payload 參數
| 名稱 | 類型 | 說明 |
| --- | --- | --- |
| `action` | `string` | **必填。** 里程碑操作類型。 |
| `number` | `integer` | **必填。** Issue 編號。 |
| `changes` | `object` | 可選。編輯欄位之前的值,或標籤變更明細。 |
| `issue` | `object` | **必填。** 被操作的 issue。 |
| `repository` | `object` | **必填。** 包含該 issue 的儲存庫。 |
| `sender` | `object` | **必填。** 執行該操作的使用者。 |
| `commit_id` | `string` | 與該 issue 操作關聯的提交 SHA如果適用則會出現。 |
#### `issue_comment`
當 issue 評論被建立、編輯或刪除時,會觸發此事件。
**動作類型:** `created``edited``deleted`
##### Payload 參數
| 名稱 | 類型 | 說明 |
| --- | --- | --- |
| `action` | `string` | **必填。** 評論操作類型。 |
| `issue` | `object` | **必填。** 該評論所屬的 issue。 |
| `pull_request` | `object` | 當該評論位於 pull request 時間線上時會出現。 |
| `comment` | `object` | **必填。** 被建立、編輯或刪除的評論。 |
| `changes` | `object` | 可選。當操作類型為 `edited` 時,表示評論內容的舊值。 |
| `repository` | `object` | **必填。** 包含該 issue 的儲存庫。 |
| `sender` | `object` | **必填。** 執行該操作的使用者。 |
| `is_pull` | `boolean` | **必填。** 該評論是否位於 pull request 時間線上。 |
### Pull Request 事件
- `pull_request``pull_request_assign``pull_request_label``pull_request_milestone``pull_request_comment``pull_request_review``pull_request_review_approved``pull_request_review_rejected``pull_request_review_comment``pull_request_sync``pull_request_review_request`
#### `pull_request`
當 pull request 被開啟、關閉、重新開啟、編輯或刪除時,會觸發此事件。
**動作類型:** `opened``closed``reopened``edited``deleted`
##### Payload 參數
| 名稱 | 類型 | 說明 |
| --- | --- | --- |
| `action` | `string` | **必填。** Pull request 操作類型。 |
| `number` | `integer` | **必填。** Pull request 編號。 |
| `changes` | `object` | 可選。編輯欄位之前的值,或標籤變更明細。 |
| `pull_request` | `object` | **必填。** 被操作的 pull request。 |
| `requested_reviewer` | `object` | 在審查請求事件中會出現。 |
| `repository` | `object` | **必填。** 包含該 pull request 的儲存庫。 |
| `sender` | `object` | **必填。** 執行該操作的使用者。 |
| `commit_id` | `string` | 與該 pull request 操作關聯的提交 SHA如果適用則會出現。 |
| `review` | `object` | 在 pull request review 事件中會出現。 |
#### `pull_request_assign`
當 pull request 被指派或取消指派時,會觸發此事件。
**動作類型:** `assigned``unassigned`
##### Payload 參數
| 名稱 | 類型 | 說明 |
| --- | --- | --- |
| `action` | `string` | **必填。** 指派操作類型。 |
| `number` | `integer` | **必填。** Pull request 編號。 |
| `changes` | `object` | 可選。編輯欄位之前的值,或標籤變更明細。 |
| `pull_request` | `object` | **必填。** 被操作的 pull request。 |
| `requested_reviewer` | `object` | 在審查請求事件中會出現。 |
| `repository` | `object` | **必填。** 包含該 pull request 的儲存庫。 |
| `sender` | `object` | **必填。** 執行該操作的使用者。 |
| `commit_id` | `string` | 與該 pull request 操作關聯的提交 SHA如果適用則會出現。 |
| `review` | `object` | 在 pull request review 事件中會出現。 |
#### `pull_request_label`
當 pull request 標籤被更新或清空時,會觸發此事件。
**動作類型:** `label_updated``label_cleared`
##### Payload 參數
| 名稱 | 類型 | 說明 |
| --- | --- | --- |
| `action` | `string` | **必填。** 標籤更新操作類型。 |
| `number` | `integer` | **必填。** Pull request 編號。 |
| `changes` | `object` | 可選。編輯欄位之前的值,或標籤變更明細。 |
| `pull_request` | `object` | **必填。** 被操作的 pull request。 |
| `requested_reviewer` | `object` | 在審查請求事件中會出現。 |
| `repository` | `object` | **必填。** 包含該 pull request 的儲存庫。 |
| `sender` | `object` | **必填。** 執行該操作的使用者。 |
| `commit_id` | `string` | 與該 pull request 操作關聯的提交 SHA如果適用則會出現。 |
| `review` | `object` | 在 pull request review 事件中會出現。 |
#### `pull_request_milestone`
當 pull request 被設定里程碑或移除里程碑時,會觸發此事件。
**動作類型:** `milestoned``demilestoned`
##### Payload 參數
| 名稱 | 類型 | 說明 |
| --- | --- | --- |
| `action` | `string` | **必填。** 里程碑操作類型。 |
| `number` | `integer` | **必填。** Pull request 編號。 |
| `changes` | `object` | 可選。編輯欄位之前的值,或標籤變更明細。 |
| `pull_request` | `object` | **必填。** 被操作的 pull request。 |
| `requested_reviewer` | `object` | 在審查請求事件中會出現。 |
| `repository` | `object` | **必填。** 包含該 pull request 的儲存庫。 |
| `sender` | `object` | **必填。** 執行該操作的使用者。 |
| `commit_id` | `string` | 與該 pull request 操作關聯的提交 SHA如果適用則會出現。 |
| `review` | `object` | 在 pull request review 事件中會出現。 |
#### `pull_request_comment`
當 pull request 時間線評論被建立、編輯或刪除時,會觸發此事件。
**動作類型:** `created``edited``deleted`
##### Payload 參數
| 名稱 | 類型 | 說明 |
| --- | --- | --- |
| `action` | `string` | **必填。** 評論操作類型。 |
| `issue` | `object` | **必填。** 與該 pull request 關聯的 issue 記錄。 |
| `pull_request` | `object` | **必填。** 評論所屬的 pull request。 |
| `comment` | `object` | **必填。** 被建立、編輯或刪除的評論。 |
| `changes` | `object` | 可選。當操作類型為 `edited` 時,表示評論內容的舊值。 |
| `repository` | `object` | **必填。** 包含該 pull request 的儲存庫。 |
| `sender` | `object` | **必填。** 執行該操作的使用者。 |
| `is_pull` | `boolean` | **必填。** 對此事件而言固定為 `true`。 |
#### `pull_request_review`
這是 Webhook 設定介面中的一個僅用於訂閱的彙總事件。
它不會產生獨立的投遞 payload。勾選後Gitea 實際投遞的是更具體的
`pull_request_review_approved``pull_request_review_rejected`
`pull_request_review_comment` 事件。
#### `pull_request_review_approved`
當 pull request review 以核准形式提交時,會觸發此事件。
**動作類型:** `reviewed`
##### Payload 參數
| 名稱 | 類型 | 說明 |
| --- | --- | --- |
| `action` | `string` | **必填。** 固定為 `reviewed`。 |
| `number` | `integer` | **必填。** Pull request 編號。 |
| `changes` | `object` | 可選。編輯欄位之前的值,或標籤變更明細。 |
| `pull_request` | `object` | **必填。** 被審查的 pull request。 |
| `requested_reviewer` | `object` | 在審查請求事件中會出現。 |
| `repository` | `object` | **必填。** 包含該 pull request 的儲存庫。 |
| `sender` | `object` | **必填。** 提交該審查的使用者。 |
| `commit_id` | `string` | 與該審查事件關聯的提交 SHA如果適用則會出現。 |
| `review` | `object` | **必填。** 審查 payload。對此事件而言`review.type``approved`。 |
#### `pull_request_review_rejected`
當 pull request review 以拒絕或請求修改的形式提交時,會觸發此事件。
**動作類型:** `reviewed`
##### Payload 參數
| 名稱 | 類型 | 說明 |
| --- | --- | --- |
| `action` | `string` | **必填。** 固定為 `reviewed`。 |
| `number` | `integer` | **必填。** Pull request 編號。 |
| `changes` | `object` | 可選。編輯欄位之前的值,或標籤變更明細。 |
| `pull_request` | `object` | **必填。** 被審查的 pull request。 |
| `requested_reviewer` | `object` | 在審查請求事件中會出現。 |
| `repository` | `object` | **必填。** 包含該 pull request 的儲存庫。 |
| `sender` | `object` | **必填。** 提交該審查的使用者。 |
| `commit_id` | `string` | 與該審查事件關聯的提交 SHA如果適用則會出現。 |
| `review` | `object` | **必填。** 審查 payload。對此事件而言`review.type``rejected`。 |
#### `pull_request_review_comment`
當 pull request review 以評論形式提交時,會觸發此事件。
**動作類型:** `reviewed`
##### Payload 參數
| 名稱 | 類型 | 說明 |
| --- | --- | --- |
| `action` | `string` | **必填。** 固定為 `reviewed`。 |
| `number` | `integer` | **必填。** Pull request 編號。 |
| `changes` | `object` | 可選。編輯欄位之前的值,或標籤變更明細。 |
| `pull_request` | `object` | **必填。** 被審查的 pull request。 |
| `requested_reviewer` | `object` | 在審查請求事件中會出現。 |
| `repository` | `object` | **必填。** 包含該 pull request 的儲存庫。 |
| `sender` | `object` | **必填。** 提交該審查的使用者。 |
| `commit_id` | `string` | 與該審查事件關聯的提交 SHA如果適用則會出現。 |
| `review` | `object` | **必填。** 審查 payload。對此事件而言`review.type``comment`。 |
#### `pull_request_sync`
當新的提交被推送後pull request 被同步時,會觸發此事件。
**動作類型:** `synchronized`
##### Payload 參數
| 名稱 | 類型 | 說明 |
| --- | --- | --- |
| `action` | `string` | **必填。** 固定為 `synchronized`。 |
| `number` | `integer` | **必填。** Pull request 編號。 |
| `changes` | `object` | 可選。編輯欄位之前的值,或標籤變更明細。 |
| `pull_request` | `object` | **必填。** 被同步的 pull request。 |
| `requested_reviewer` | `object` | 在審查請求事件中會出現。 |
| `repository` | `object` | **必填。** 包含該 pull request 的儲存庫。 |
| `sender` | `object` | **必填。** 執行同步操作的使用者。 |
| `commit_id` | `string` | 與該同步事件關聯的提交 SHA如果適用則會出現。 |
| `review` | `object` | 在 pull request review 事件中會出現。 |
#### `pull_request_review_request`
當請求審查者或移除審查請求時,會觸發此事件。
**動作類型:** `review_requested``review_request_removed`
##### Payload 參數
| 名稱 | 類型 | 說明 |
| --- | --- | --- |
| `action` | `string` | **必填。** 審查請求操作類型。 |
| `number` | `integer` | **必填。** Pull request 編號。 |
| `changes` | `object` | 可選。編輯欄位之前的值,或標籤變更明細。 |
| `pull_request` | `object` | **必填。** 被操作的 pull request。 |
| `requested_reviewer` | `object` | 被請求或被移除的審查者。 |
| `repository` | `object` | **必填。** 包含該 pull request 的儲存庫。 |
| `sender` | `object` | **必填。** 執行該操作的使用者。 |
| `commit_id` | `string` | 與該 pull request 操作關聯的提交 SHA如果適用則會出現。 |
| `review` | `object` | 在 pull request review 事件中會出現。 |
### 工作流程事件
- `workflow_run``workflow_job`
#### `workflow_run`
當 Gitea Actions 工作流程執行狀態發生變化時,會觸發此事件。
**動作類型:** `queued``waiting``in_progress``completed`
##### Payload 參數
| 名稱 | 類型 | 說明 |
| --- | --- | --- |
| `action` | `string` | **必填。** 工作流程執行狀態變化。 |
| `workflow` | `object` | **必填。** 工作流程定義。 |
| `workflow_run` | `object` | **必填。** 被操作的工作流程執行記錄。 |
| `pull_request` | `object` | 當該工作流程執行與某個 pull request 相關時會出現。 |
| `organization` | `object` | 當儲存庫擁有者是組織時會出現。 |
| `repository` | `object` | **必填。** 包含該工作流程的儲存庫。 |
| `sender` | `object` | **必填。** 觸發該工作流程執行更新的使用者。 |
#### `workflow_job`
當 Gitea Actions 工作流程作業狀態發生變化時,會觸發此事件。
**動作類型:** `queued``waiting``in_progress``completed`
##### Payload 參數
| 名稱 | 類型 | 說明 |
| --- | --- | --- |
| `action` | `string` | **必填。** 工作流程作業狀態變化。 |
| `workflow_job` | `object` | **必填。** 被操作的工作流程作業。 |
| `pull_request` | `object` | 當該工作流程作業與某個 pull request 相關時會出現。 |
| `organization` | `object` | 當儲存庫擁有者是組織時會出現。 |
| `repository` | `object` | **必填。** 包含該工作流程作業的儲存庫。 |
| `sender` | `object` | **必填。** 觸發該工作流程作業更新的使用者。 |
## 測試、最近投遞與重新投遞
每個 Webhook 頁面都包含:
- `Test Delivery`:會向儲存庫送出一次模擬的 `push` 事件。
- `Recent Deliveries`:顯示請求與回應詳細資訊。
- `Redelivery`:重新投遞一筆歷史 Webhook 記錄。
如果儲存庫還沒有任何提交,測試投遞會使用一個產生的假提交,以便仍能測試
Webhook。
## 管理說明
管理員還可以透過實例層級設定控制 Webhook 投遞,例如主機允許清單、投遞逾時
與清理策略。詳見
[設定速查表中的 Webhook 小節](../../administration/config-cheat-sheet.md#webhook-webhook)。