diff options
| author | Zettat123 <zettat123@gmail.com> | 2023-09-20 14:28:35 +0800 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-09-20 06:28:35 +0000 |
| commit | 9336286e353370d76d9804043ee6af8f2fe35e00 (patch) | |
| tree | 10d1b0f104bc877562dad5e0e6866c5c57b004de /docs | |
| parent | 24a215e317103471aeb864f365089a36076efc1d (diff) | |
| download | gitea-9336286e353370d76d9804043ee6af8f2fe35e00.tar.gz gitea-9336286e353370d76d9804043ee6af8f2fe35e00.zip | |
Improve actions docs related to `pull_request` event (#27126)
Related to #27039
The `ref` property in Gitea Actions is different from GitHub Actions.
This PR improves the documentation to explain the difference.
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/content/usage/actions/faq.en-us.md | 3 | ||||
| -rw-r--r-- | docs/content/usage/actions/faq.zh-cn.md | 3 |
2 files changed, 6 insertions, 0 deletions
diff --git a/docs/content/usage/actions/faq.en-us.md b/docs/content/usage/actions/faq.en-us.md index 031509a033..1d59872936 100644 --- a/docs/content/usage/actions/faq.en-us.md +++ b/docs/content/usage/actions/faq.en-us.md @@ -180,3 +180,6 @@ For events supported only by GitHub, see GitHub's [documentation](https://docs.g | pull_request_review_comment | `created`, `edited` | | release | `published`, `edited` | | registry_package | `published` | + +> For `pull_request` events, in [GitHub Actions](https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#pull_request), the `ref` is `refs/pull/:prNumber/merge`, which is a reference to the merge commit preview. However, Gitea has no such reference. +> Therefore, the `ref` in Gitea Actions is `refs/pull/:prNumber/head`, which points to the head of pull request rather than the preview of the merge commit. diff --git a/docs/content/usage/actions/faq.zh-cn.md b/docs/content/usage/actions/faq.zh-cn.md index f5dc8e179b..7bb79d02fc 100644 --- a/docs/content/usage/actions/faq.zh-cn.md +++ b/docs/content/usage/actions/faq.zh-cn.md @@ -180,3 +180,6 @@ defaults: | pull_request_review_comment | `created`, `edited` | | release | `published`, `edited` | | registry_package | `published` | + +> 对于 `pull_request` 事件，在 [GitHub Actions](https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#pull_request) 中 `ref` 是 `refs/pull/:prNumber/merge`，它指向这个拉取请求合并提交的一个预览。但是 Gitea 没有这种 reference。 +> 因此，Gitea Actions 中 `ref` 是 `refs/pull/:prNumber/head`，它指向这个拉取请求的头分支而不是合并提交的预览。 |