In the first paragraph, explain our weird Woodpecker instance in more depth

Anthony Wang 2024-02-25 04:22:54 +00:00
parent 81a7dcc612
commit f721c1102c

8
CI.md

@ -1,12 +1,12 @@
We host [Woodpecker CI](https://woodpecker-ci.org/) at https://ci.exozy.me.
We host [Woodpecker CI](https://woodpecker-ci.org/) at https://ci.exozy.me. But watch out: Our instance is a bit weird, because it's [patched](https://git.exozy.me/exozyme/packages/src/branch/main/woodpecker-agent-sudo/sudo.patch) to run pipelines as your user on our server, not in a container. You should think of our CI as an automation tool, not a CI, since it doesn't give you a pristine, clean environment for each build. Although if you want a clean environment, you can make your pipeline run a container.
## Usage
You can find an example build pipeline [here](https://git.exozy.me/a/Hello-world/src/branch/main/.woodpecker.yml). The pipeline runs as your user on the server, not in a container. The repo is cloned to `~/.cache/woodpecker/reponame` so you can also SSH into exozyme and inspect failed builds.
You can find example build pipeline [here](https://git.exozy.me/a/Hello-world/src/branch/main/.woodpecker.yml) and [here](https://git.exozy.me/a/website/src/branch/main/.woodpecker.yml). Repos are cloned to `~/.cache/woodpecker/reponame`, so you can SSH into exozyme and inspect failed builds.
### Pipeline `image`
Since our instance runs on the `local` backend rather than the `docker` backend, passing a container image name in the `image` field will not work. Instead, you should pass one of the shells available in the system (ex. `bash`, `fish`), and that will run your commands.
Since our instance doesn't use containers, you should not specify a container image for the `image` field. Instead, you should pass one of the shells available in the system (ex. `bash`, `fish`) to run your pipeline.
## Tips and tricks
@ -16,4 +16,4 @@ Add `export DBUS_SESSION_BUS_ADDRESS=unix:path=/run/user/$(id -u)/bus` to your p
## See also
- https://woodpecker-ci.org/docs/next/usage/intro
- https://woodpecker-ci.org/docs/usage/intro