From de988a1bfb5b61106507003cb58753eaf714a4bb Mon Sep 17 00:00:00 2001 From: Earl Warren Date: Tue, 1 Jul 2025 17:49:37 +0000 Subject: [PATCH] chore(docs): add an architecture section in the readme (#629) So tahtthe related issues that are either stalled or whishlist can be closed until someone has time to work on them. Closes forgejo/runner#386 Closes forgejo/runner#81 Reviewed-on: https://code.forgejo.org/forgejo/runner/pulls/629 Reviewed-by: Michael Kriese Co-authored-by: Earl Warren Co-committed-by: Earl Warren --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index 9d2a9b22..1df733f7 100644 --- a/README.md +++ b/README.md @@ -8,6 +8,16 @@ A daemon that connects to a Forgejo instance and runs jobs for continuous integr When filing a bug in [the issue tracker](https://code.forgejo.org/forgejo/runner/issues), it is very helpful to propose a pull request [in the end-to-end tests](https://code.forgejo.org/forgejo/end-to-end/src/branch/main/actions) repository that adds a reproducer. It will fail the CI and unambiguously demonstrate that the problem exists. In most cases it is enough to add a workflow ([see the echo example](https://code.forgejo.org/forgejo/end-to-end/src/branch/main/actions/example-echo)). For more complicated cases it is also possible to add a runner config file as well as shell scripts to setup and teardown the test case ([see the service example](https://code.forgejo.org/forgejo/end-to-end/src/branch/main/actions/example-service)). +# 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) +- [Windows](https://code.forgejo.org/forgejo/runner/issues?labels=365) + # Hacking The Forgejo runner depends on [a fork of ACT](https://code.forgejo.org/forgejo/act) and 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.