mirror of
https://gitea.com/gitea/act_runner.git
synced 2026-05-02 08:50:45 +08:00
13dc9386fe
## Consumer-facing breaking changes
- **Go module path**: `gitea.com/gitea/act_runner` → `gitea.com/gitea/runner`. Anything importing `act/...` or `internal/...` packages (notably Gitea itself) must update imports.
- **Binary name**: `act_runner` → `gitea-runner`. Wrapper scripts, systemd units, init scripts, and documentation referencing the binary by `act_runner` will break.
- **Docker image**: `gitea/act_runner` → `gitea/runner` (incl. `*-dind-rootless` variants). Users pulling `gitea/act_runner:nightly` etc. will get stale images. Note: the image name is `gitea/runner`, not `gitea/gitea-runner`.
- **Release artifact paths**: S3 directory `act_runner/{{.Version}}` → `gitea-runner/{{.Version}}`, and artifact filenames change with the new project name. Existing download URLs break.
- **Metrics namespace**: changed from `act_runner` to `gitea_runner` (e.g. `act_runner_jobs_total` → `gitea_runner_jobs_total`); existing monitors/dashboards must be updated.
- **ldflags version path**: `gitea.com/gitea/act_runner/internal/pkg/ver.version` → `gitea.com/gitea/runner/internal/pkg/ver.version`. Affects anyone building with custom ldflags.
- **Kubernetes example resource names**: `act-runner` / `act-runner-vol` → `runner` / `runner-vol`. Users who copied the manifests verbatim will see resource churn on apply.
- **s6 service name**: `scripts/s6/act_runner/` → `scripts/s6/gitea-runner/` (image-internal; only matters for downstream image overrides).
Unchanged: YAML config field names, env vars (`GITEA_*`), CLI flags/subcommands, registration file format.
---------
Co-authored-by: silverwind <me@silverwind.io>
Reviewed-on: https://gitea.com/gitea/runner/pulls/850
Reviewed-by: Zettat123 <39446+zettat123@noreply.gitea.com>
Reviewed-by: silverwind <2021+silverwind@noreply.gitea.com>
Reviewed-by: Nicolas <bircni@icloud.com>
Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com>
Co-committed-by: Lunny Xiao <xiaolunwen@gmail.com>
65 lines
2.0 KiB
Markdown
65 lines
2.0 KiB
Markdown
### Running `gitea-runner` using `docker-compose`
|
|
|
|
```yml
|
|
...
|
|
gitea:
|
|
image: gitea/gitea
|
|
...
|
|
healthcheck:
|
|
# checks availability of Gitea's front-end with curl
|
|
test: ["CMD", "curl", "-f", "<instance_url>"]
|
|
interval: 10s
|
|
retries: 3
|
|
start_period: 30s
|
|
timeout: 10s
|
|
environment:
|
|
# GITEA_RUNNER_REGISTRATION_TOKEN can be used to set a global runner registration token.
|
|
# The Gitea version must be v1.23 or higher.
|
|
# It's also possible to use GITEA_RUNNER_REGISTRATION_TOKEN_FILE to pass the location.
|
|
# - GITEA_RUNNER_REGISTRATION_TOKEN=<user-defined registration token>
|
|
|
|
runner:
|
|
image: gitea/runner
|
|
restart: always
|
|
depends_on:
|
|
gitea:
|
|
# required so runner can attach to gitea, see "healthcheck"
|
|
condition: service_healthy
|
|
restart: true
|
|
volumes:
|
|
- ./data/runner:/data
|
|
- /var/run/docker.sock:/var/run/docker.sock
|
|
environment:
|
|
- GITEA_INSTANCE_URL=<instance url>
|
|
# When using Docker Secrets, it's also possible to use
|
|
# GITEA_RUNNER_REGISTRATION_TOKEN_FILE to pass the location.
|
|
# The env var takes precedence.
|
|
# Needed only for the first start.
|
|
- GITEA_RUNNER_REGISTRATION_TOKEN=<registration token>
|
|
```
|
|
|
|
### Running `gitea-runner` using Docker-in-Docker (DIND)
|
|
|
|
```yml
|
|
...
|
|
runner:
|
|
image: gitea/runner:latest-dind-rootless
|
|
restart: always
|
|
privileged: true
|
|
depends_on:
|
|
- gitea
|
|
volumes:
|
|
- ./data/runner:/data
|
|
environment:
|
|
- GITEA_INSTANCE_URL=<instance url>
|
|
- DOCKER_HOST=unix:///var/run/user/1000/docker.sock
|
|
# Use slirp4netns instead of vpnkit for significantly better network throughput.
|
|
- DOCKERD_ROOTLESS_ROOTLESSKIT_NET=slirp4netns
|
|
- DOCKERD_ROOTLESS_ROOTLESSKIT_MTU=65520
|
|
# When using Docker Secrets, it's also possible to use
|
|
# GITEA_RUNNER_REGISTRATION_TOKEN_FILE to pass the location.
|
|
# The env var takes precedence.
|
|
# Needed only for the first start.
|
|
- GITEA_RUNNER_REGISTRATION_TOKEN=<registration token>
|
|
```
|