Forgejo Runner

A daemon that connects to a Forgejo instance and runs jobs for continuous integration. The installation and usage instructions are part of the Forgejo documentation. Forgejo Runner can also run workflows locally and act as a cache.

Forgejo Runner is distributed under the terms of the GPL version 3.0 or any later version.

Issues

• Feature requests
• Runner-specific issues
• Forgejo Actions issues

It is totally okay to report issues in the "wrong" place; identifying the right place is hard. In the worst case, we will ask you to open it somewhere else because issues cannot be transferred between instances.

Reporting Security Vulnerabilities

Please report security-related issues to security@forgejo.org using encryption.

Contributing

See the contribution guide.

Architectures & OS

The Forgejo runner is supported and tested on amd64 and arm64 (binaries and containers) 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
• linux-powerpc64le
• linux-riscv64
• Windows

Development

The Forgejo runner is a dependency of the setup-forgejo action. See the full dependency graph for a global view.

Building

• Install Go and make(1)
• make build

Linting

• make lint-check
• make lint # will fix some lint errors

Testing

There are three kinds of tests for Forgejo Runner:

• Unit tests
• Integration tests
• End-to-end tests that involve a running Forgejo instance

Unit and integration tests are included in this repository, whereas end-to-end tests are maintained separately.

Tests can either be run using predefined GNU Make targets or go test.

Running Tests

To run all unit tests with GNU Make, run:

$ make test

Or with go test, run:

$ go test -short ./...

To run all integration tests with GNU Make, run:

$ make integration-test

Or with go test, run:

$ go test ./...

Toggling Tests by Feature

Forgejo Runner integrates with various technologies like Docker and LXC. They are not available on all platforms that Forgejo Runner can run on. The related tests take a long time to execute, too. It is possible to enable or disable the tests with the help of the test argument -features. All feature-related tests are enabled by default.

-features takes a list of comma-separated feature names. For example, to run all tests including those related to docker and lxc, invoke:

$ go test ./... -args -features "docker,lxc"

If all feature-related tests should be skipped, run:

$ go test ./... -args -features "-"

If -features is not present, all feature-related tests will be enabled.

List of all feature toggles:

Key	Purpose
docker	Toggles tests that require Docker or Podman.
lxc	Toggles tests that require LXC.

Running End-to-End Tests

For running end-to-end tests during development, please see the instructions in the respective repository where the end-to-end tests are maintained.

During CI, the end-to-end tests can be triggered for a particular pull request by attaching the label run-end-to-end-tests.