diff --git a/gitea-act-runner/CHANGELOG.md b/gitea-act-runner/CHANGELOG.md new file mode 100644 index 0000000..ae4e326 --- /dev/null +++ b/gitea-act-runner/CHANGELOG.md @@ -0,0 +1,10 @@ +# Changelog + +## 1.0.0 - 2026-04-01 + +- Initial release +- Self-registers to Gitea on first boot using options from HA supervisor +- Persists `.runner` registration file in `/data/` across restarts +- Generates `act_runner_config.yaml` at runtime from configured options +- Docker socket access via `full_access: true` for job container spawning +- Configurable: `gitea_url`, `runner_token`, `runner_name`, `runner_labels`, `log_level` diff --git a/gitea-act-runner/DOCS.md b/gitea-act-runner/DOCS.md index ff61fab..04dde00 100644 --- a/gitea-act-runner/DOCS.md +++ b/gitea-act-runner/DOCS.md @@ -1,88 +1,37 @@ -# Gitea act_runner — Home Assistant Addon +# Gitea act_runner -Runs the [Gitea Actions runner](https://gitea.com/gitea/act_runner) as a native Home Assistant addon, allowing your HAOS machine to execute Gitea CI/CD jobs. +Runs the Gitea Actions runner on your Home Assistant machine. +The runner self-registers on first boot and persists its state across restarts. ---- +## Setup -## Prerequisites +1. Get a registration token: **Gitea → Site Admin → Actions → Runners → Create new runner** +2. Set `gitea_url` to your Gitea LAN IP, e.g. `http://192.168.1.50:3000` — **not** `localhost` +3. Paste the token into `runner_token` +4. Start the add-on -1. A running **Gitea instance** (version ≥ 1.21) with Actions enabled. - In Gitea: **Site Administration → Configuration** — confirm `[actions] ENABLED = true`. -2. A **runner registration token** from your Gitea instance (see below). -3. The Gitea instance must be reachable from your HA machine by a **LAN IP address** (e.g. `http://192.168.1.50:3000`), not `localhost`. +## Runner Labels ---- - -## Getting the Registration Token - -1. Log in to Gitea as a **site administrator**. -2. Navigate to **Site Administration → Actions → Runners**. -3. Click **Create new runner**. -4. Copy the displayed registration token — you will paste it into the addon options. - -> **Tip:** Tokens can also be scoped to an organisation or a single repository via the respective *Settings → Actions → Runners* page if you don't want a global runner. - ---- - -## Configuration Options - -| Option | Required | Default | Description | -|---|---|---|---| -| `gitea_url` | ✅ | — | Full URL of your Gitea instance, e.g. `http://192.168.1.50:3000` | -| `runner_token` | ✅ | — | Registration token from the Gitea Runners page | -| `runner_name` | | `haos-runner` | Display name shown in Gitea's runner list | -| `runner_labels` | | `ubuntu-latest:docker://catthehacker/ubuntu:act-22.04` | Comma-separated list of labels this runner accepts | -| `log_level` | | `info` | Verbosity: `debug`, `info`, `warn`, or `error` | - ---- - -## Runner Labels Format - -Labels tell Gitea which job `runs-on:` values this runner handles, and which Docker image to use for each: - -``` -