From cb63f3ef8a70b92c93dc090fae054c2f8c51ae10 Mon Sep 17 00:00:00 2001 From: silverwind Date: Thu, 12 Nov 2026 06:23:01 +0000 Subject: [PATCH] Remove the builtin:checkout docs (#643) Follow-up to https://gitea.com/gitea/runner/pulls/1407, which removes the runner's builtin actions. Drops `builtin:checkout` from the develop runner docs and the current comparison page, and lists the removal under the 6.0 breaking changes. Versioned docs keep it, as released runners still ship it, with their `builtin-actions.md` links pinned to the latest 4.x and 5.x tags since the file leaves runner main. Co-authored-by: Lunny Xiao Reviewed-on: https://gitea.com/gitea/docs/pulls/643 Reviewed-by: Lunny Xiao Co-authored-by: silverwind --- docs/usage/actions/comparison.md | 5 +---- i18n/zh-cn/docs/current/usage/actions/comparison.md | 5 +---- i18n/zh-tw/docs/current/usage/actions/comparison.md | 5 +---- runner-docs/index.md | 1 - runner-docs/jobs.md | 4 ---- runner-docs/upgrade.md | 4 ++++ runner-docs_versioned_docs/version-4/upgrade.md | 2 +- runner-docs_versioned_docs/version-5/jobs.md | 2 +- 8 files changed, 9 insertions(+), 19 deletions(-) diff --git a/docs/usage/actions/comparison.md b/docs/usage/actions/comparison.md index fd8620c9..15789f70 100644 --- a/docs/usage/actions/comparison.md +++ b/docs/usage/actions/comparison.md @@ -16,10 +16,7 @@ Gitea Actions is designed to be compatible with GitHub Actions, with the differe ### Action prefixes -`uses:` accepts these prefixes: - -- `self:` references your own Gitea instance, e.g. `uses: self:owner/repo@v1` or `uses: self:owner/repo/.gitea/workflows/build.yml@v1` -- `builtin:` runs an action built into Gitea Runner, which needs no download and does not depend on Node.js, e.g. `uses: builtin:checkout` +`uses:` accepts the `self:` prefix to reference your own Gitea instance, e.g. `uses: self:owner/repo@v1` or `uses: self:owner/repo/.gitea/workflows/build.yml@v1`. ### Actions written in Go diff --git a/i18n/zh-cn/docs/current/usage/actions/comparison.md b/i18n/zh-cn/docs/current/usage/actions/comparison.md index f9625fac..013e4235 100644 --- a/i18n/zh-cn/docs/current/usage/actions/comparison.md +++ b/i18n/zh-cn/docs/current/usage/actions/comparison.md @@ -18,10 +18,7 @@ Gitea Actions旨在与GitHub Actions兼容，差异如下。 ### Action前缀 -`uses:`支持以下前缀： - -- `self:`引用您自己的Gitea实例，例如`uses: self:owner/repo@v1`或`uses: self:owner/repo/.gitea/workflows/build.yml@v1` -- `builtin:`运行Gitea Runner内置的Action，无需下载，也不依赖Node.js，例如`uses: builtin:checkout` +`uses:`支持`self:`前缀，用于引用您自己的Gitea实例，例如`uses: self:owner/repo@v1`或`uses: self:owner/repo/.gitea/workflows/build.yml@v1`。 ### 使用Go编写Actions diff --git a/i18n/zh-tw/docs/current/usage/actions/comparison.md b/i18n/zh-tw/docs/current/usage/actions/comparison.md index dbcb07ca..56d2baab 100644 --- a/i18n/zh-tw/docs/current/usage/actions/comparison.md +++ b/i18n/zh-tw/docs/current/usage/actions/comparison.md @@ -18,10 +18,7 @@ Gitea Actions 旨在與 GitHub Actions 相容，差異如下。 ### Action 前綴 -`uses:` 接受以下前綴： - -- `self:` 參照您自己的 Gitea 實例，例如 `uses: self:owner/repo@v1` 或 `uses: self:owner/repo/.gitea/workflows/build.yml@v1` -- `builtin:` 執行 Gitea Runner 內建的 Action，無需下載，也不依賴 Node.js，例如 `uses: builtin:checkout` +`uses:` 接受 `self:` 前綴，用於參照您自己的 Gitea 實例，例如 `uses: self:owner/repo@v1` 或 `uses: self:owner/repo/.gitea/workflows/build.yml@v1`。 ### 使用Go編寫Actions diff --git a/runner-docs/index.md b/runner-docs/index.md index d9f629d3..ed836c5b 100644 --- a/runner-docs/index.md +++ b/runner-docs/index.md @@ -23,7 +23,6 @@ Jobs need these tools wherever steps run, in the job image or on the host: - `bash` or `sh` for `run` steps, or `pwsh` or `powershell` on Windows. - `node` for JavaScript actions and `hashFiles()`. -- `git` 2.34.1 or later for [`builtin:checkout`](jobs.md#built-in-checkout), plus `git-lfs` for its `lfs` input and `ssh` for its `ssh-key` input. ## Where jobs run diff --git a/runner-docs/jobs.md b/runner-docs/jobs.md index 10431515..85d38ba1 100644 --- a/runner-docs/jobs.md +++ b/runner-docs/jobs.md @@ -68,10 +68,6 @@ Setup actions such as `actions/setup-go` install tools in `/opt/hostedtoolcache` With `none`, include tools in the job image at `/opt/hostedtoolcache///`. Place an empty `.complete` file next to the directory. The `-full` variant of the [runner images](https://gitea.com/gitea/runner-images) includes its tools this way. -## Built-in checkout - -`uses: builtin:checkout` checks out the repository like `actions/checkout`. It does not download an action or require Node in the job image. It runs `git` in the job. See [Requirements](index.md#requirements) and the inputs listed in [builtin-actions.md](https://gitea.com/gitea/runner/src/branch/main/docs/builtin-actions.md). - ## Secrets The runner masks secrets and `::add-mask::` values in job logs, job summaries, and the names of containers it creates. The runner does not send job outputs that contain a secret. A `needs..outputs.` expression that reads such an output is empty. diff --git a/runner-docs/upgrade.md b/runner-docs/upgrade.md index d6921ffe..6bb85f2c 100644 --- a/runner-docs/upgrade.md +++ b/runner-docs/upgrade.md @@ -14,6 +14,10 @@ sudo systemctl start gitea-runner Stopping the runner cancels running jobs unless `runner.shutdown_timeout` gives them time to finish. The runner logs a warning for unknown configuration keys and ignores them. Run `gitea-runner config generate` to list all configuration options. +## Breaking changes in 6.0 + +- **`builtin:checkout` is removed.** Steps that use it fail. Use `actions/checkout` or a lightweight action such as [`taiki-e/checkout-action`](https://github.com/taiki-e/checkout-action). + ## Breaking changes in 5.0 - **Git 2.34.1 or later is required** on the runner and in job images that use `builtin:checkout`. diff --git a/runner-docs_versioned_docs/version-4/upgrade.md b/runner-docs_versioned_docs/version-4/upgrade.md index f7b484f5..73d71e2d 100644 --- a/runner-docs_versioned_docs/version-4/upgrade.md +++ b/runner-docs_versioned_docs/version-4/upgrade.md @@ -26,7 +26,7 @@ Config files are read leniently: keys the running version does not know are repo ### Also new -- `builtin:checkout`, which needs neither a download nor Node in the job image, see [docs/builtin-actions.md](https://gitea.com/gitea/runner/src/branch/main/docs/builtin-actions.md), and the `self:` prefix for actions hosted on the runner's own instance. +- `builtin:checkout`, which needs neither a download nor Node in the job image, see [docs/builtin-actions.md](https://gitea.com/gitea/runner/src/tag/v4.1.0/docs/builtin-actions.md), and the `self:` prefix for actions hosted on the runner's own instance. - S3-compatible storage as a cache backend (`cache.s3` in the [example configuration](reference/config-example.md)), shared between runners without a cache server. - [OpenTelemetry tracing](monitoring.md#opentelemetry-tracing) of jobs and steps, and from `4.1` the Prometheus metrics exported through OpenTelemetry as well. - A Kubernetes backend that runs jobs as pods (`4.1`), see [docs/kubernetes.md](https://gitea.com/gitea/runner/src/branch/main/docs/kubernetes.md). diff --git a/runner-docs_versioned_docs/version-5/jobs.md b/runner-docs_versioned_docs/version-5/jobs.md index 10431515..44ba3b44 100644 --- a/runner-docs_versioned_docs/version-5/jobs.md +++ b/runner-docs_versioned_docs/version-5/jobs.md @@ -70,7 +70,7 @@ With `none`, include tools in the job image at `/opt/hostedtoolcache//