silverwindandLunny Xiao
cb63f3ef8a
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 <[email protected]> Reviewed-on: https://gitea.com/gitea/docs/pulls/643 Reviewed-by: Lunny Xiao <[email protected]> Co-authored-by: silverwind <[email protected]>
1.8 KiB
sidebar_position, slug
| sidebar_position | slug |
|---|---|
| 1 | / |
Gitea Runner
Gitea Runner runs Gitea Actions jobs. It asks a Gitea instance for jobs, runs them, and sends their logs and results back.
:::info Development version
These pages describe builds from the main branch, published as nightly binaries and images.
Select a release in the Runner Version dropdown for stable documentation.
:::
Requirements
- Gitea 1.21 or later with Actions enabled, the default setting.
- Git 2.34.1 or later on the runner's
PATH. - Docker, or Podman with
podman.socketenabled, for jobs in containers, Docker actions, anddocker://steps.
Jobs need these tools wherever steps run, in the job image or on the host:
bashorshforrunsteps, orpwshorpowershellon Windows.nodefor JavaScript actions andhashFiles().
Where jobs run
The runner's labels determine where each job runs. One runner can use a mix of these environments:
| Label | Where the job runs |
|---|---|
docker://<image> |
In a container |
kubernetes://<image> |
In a pod in a Kubernetes cluster |
host |
Directly on the runner's machine |
Host jobs run as the runner's user without isolation. Use them only for trusted repositories.
Getting started
- Install the runner from a binary, with Docker, or on Kubernetes.
- Register it with your Gitea instance.
- Start it with
gitea-runner daemon.
The runner works without a configuration file. Configuration explains when you need one.
The runner is released independently of Gitea. Read Upgrading before moving to a new major version.