mirror of
https://code.forgejo.org/forgejo/runner.git
synced 2025-09-05 18:40:59 +00:00
8eda2e40a4
- Explain how to run tests locally instead of pointing to the workflow. - Explain how to run lint checks & fix locally - Replace the `forgejo-setup` based instructions with shorter and more actionable instructions based out of the end-to-end tests. - Remove the reporting bug section, the issue template has all the information it needs. It is unlikely that someone reporting a bug will read that section in the README before filing the bug. It removes the suggestion to file a bug in the end-to-end repository but I don't think it was actually beneficial to anyone in the past two years. - Remove the mock generation part as it is now self documented in the job that takes care of it. <!--start release-notes-assistant--> <!--URL:https://code.forgejo.org/forgejo/runner--> - other - [PR](https://code.forgejo.org/forgejo/runner/pulls/903): <!--number 903 --><!--line 0 --><!--description Y2hvcmU6IHJld29yayB0aGUgUkVBRE1FIFtza2lwIGNhc2NhZGVd-->chore: rework the README [skip cascade]<!--description--> <!--end release-notes-assistant--> Reviewed-on: https://code.forgejo.org/forgejo/runner/pulls/903 Reviewed-by: Gusted <gusted@noreply.code.forgejo.org> Reviewed-by: Mathieu Fenniak <mfenniak@noreply.code.forgejo.org> Co-authored-by: Earl Warren <contact@earl-warren.org> Co-committed-by: Earl Warren <contact@earl-warren.org>
69 lines
3.7 KiB
Markdown
69 lines
3.7 KiB
Markdown
# Forgejo Runner
|
|
|
|
A daemon that connects to a Forgejo instance and runs jobs for continuous integration. The [installation and usage instructions](https://forgejo.org/docs/next/admin/actions/) are part of the Forgejo documentation.
|
|
|
|
# Reporting security-related issues
|
|
|
|
Sensitive security-related issues should be reported to [security@forgejo.org](mailto:security@forgejo.org) using [encryption](https://keyoxide.org/security@forgejo.org).
|
|
|
|
## License
|
|
|
|
The Forgejo runner source code is distributed under the terms of the following licenses:
|
|
|
|
- [MIT](LICENSE) for the most part.
|
|
- [Apache 2](act/container/DOCKER_LICENSE) for parts found in the [act/container](act/container) directory.
|
|
|
|
# Architectures & OS
|
|
|
|
The Forgejo runner is supported and tested on `amd64` and `arm64` ([binaries](https://code.forgejo.org/forgejo/runner/releases) and [containers](https://code.forgejo.org/forgejo/-/packages/container/runner/versions)) on Operating Systems based on the Linux kernel.
|
|
|
|
Work may be in progress for other architectures and you can browse the corresponding issues to figure out how they make progress. If you are interested in helping them move forward, open an issue. The most challenging part is to setup and maintain a native runner long term. Once it is supported by Forgejo, the runner is expected to be available 24/7 which can be challenging. Otherwise debugging any architecture specific problem won't be possible.
|
|
|
|
- [linux-s390x](https://code.forgejo.org/forgejo/runner/issues?labels=969)
|
|
- [linux-powerpc64le](https://code.forgejo.org/forgejo/runner/issues?labels=968)
|
|
- [linux-riscv64](https://code.forgejo.org/forgejo/runner/issues?labels=970)
|
|
- [Windows](https://code.forgejo.org/forgejo/runner/issues?labels=365)
|
|
|
|
# Hacking
|
|
|
|
The Forgejo runner is a dependency of the [setup-forgejo action](https://code.forgejo.org/actions/setup-forgejo). See [the full dependency graph](https://code.forgejo.org/actions/cascading-pr/#forgejo-dependencies) for a global view.
|
|
|
|
## Building
|
|
|
|
- Install [Go](https://go.dev/doc/install) and `make(1)`
|
|
- `make build`
|
|
|
|
## Linting
|
|
|
|
- `make lint-check`
|
|
- `make lint` # will fix some lint errors
|
|
|
|
## Testing
|
|
|
|
The [workflow](.forgejo/workflows/test.yml) that runs in the CI uses similar commands.
|
|
|
|
### Without a Forgejo instance
|
|
|
|
- Install [Docker](https://docs.docker.com/engine/install/)
|
|
- `make test integration-test`
|
|
|
|
### With a Forgejo instance
|
|
|
|
- Run a Forgejo instance locally (for instance at http://0.0.0.0:8080) and create as shared secret
|
|
```sh
|
|
export FORGEJO_RUNNER_SECRET='AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA'
|
|
export FORGEJO_URL=http://0.0.0.0:8080
|
|
forgejo forgejo-cli actions register --labels docker --name therunner --secret $FORGEJO_RUNNER_SECRET
|
|
```
|
|
- `make test integration-test` # which will run addional tests because FORGEJO_URL is set
|
|
|
|
### end-to-end
|
|
|
|
- Follow the instructions from the end-to-end tests to [run actions tests locally](https://code.forgejo.org/forgejo/end-to-end#running-from-locally-built-binary).
|
|
- `./end-to-end.sh actions_teardown` # stop the Forgejo and runner daemons running in the end-to-end environment
|
|
- `( cd ~/clone-of-the-runner-repo ; make build ; cp forgejo-runner /tmp/forgejo-end-to-end/forgejo-runner )` # install the runner built from sources
|
|
- `./end-to-end.sh actions_setup 13.0` # start Forgejo v13.0 and the runner daemon in the end-to-end environment
|
|
- `./end-to-end.sh actions_verify_example echo` # run the [echo workflow](https://code.forgejo.org/forgejo/end-to-end/src/branch/main/actions/example-echo/.forgejo/workflows/test.yml)
|
|
- `xdg-open http://127.0.0.1:3000/root/example-echo/actions/runs/1` # see the logs workflow
|
|
- `less /tmp/forgejo-end-to-end/forgejo-runner.log` # analyze the runner logs
|
|
- `less /tmp/forgejo-end-to-end/forgejo-work-path/log/forgejo.log` # analyze the Forgejo logs
|