Forgejo runner - alpha release, should not be considered secure enough to deploy in production
Find a file
Merith ea96696f10 remove rootless dockerfile, updatedate entrypoint, update docker compose
Removed the rootless dockerfile as upon further investigation into how a `rootless` container works, the entrypoint that has been written fully accomodates that

to reflect this the compose file has had the rootless config removed from it as it is no longer needed to test a seperate container image,

added a debug echo function `decho` to the entrypoint, when `DEBUG=true` it will print "[entrypoint] message content"

added a 10 second wait to the entrypoint to allow other services such as docker-in-docker and forgejo to finish launching before the runner is launched, this is bypassable by `SKIP_WAIT=true`

applied several modifications requested by viceice,
2024-09-26 15:08:31 -07:00
.forgejo revert changes to workflow 2024-09-26 07:28:00 -07:00
contrib Fix comments in systemd unit service file (#274) 2024-09-18 13:40:32 +00:00
examples remove rootless dockerfile, updatedate entrypoint, update docker compose 2024-09-26 15:08:31 -07:00
internal chore: add test for unexpected YAML type in top level env 2024-09-15 16:05:01 +02:00
scripts add instructions to run under systemd user services 2024-02-19 09:09:57 +01:00
.dockerignore [FORGEJO] build forgejo-runner 2023-08-23 14:44:47 +02:00
.editorconfig Add .editorconfig and .gitattributes (#186) 2023-05-13 23:51:22 +08:00
.gitattributes Add .editorconfig and .gitattributes (#186) 2023-05-13 23:51:22 +08:00
.gitignore [FORGEJO] build forgejo-runner 2023-08-23 14:44:47 +02:00
.golangci.yml ci(lint): refactor code for clarity and linting compliance (#289) 2023-07-13 01:10:54 +00:00
build.go Support cache (#25) 2023-02-28 23:39:30 +08:00
Dockerfile update entrypoint and dockerfile, fix test workflow 2024-09-25 16:05:56 -07:00
entrypoint.sh remove rootless dockerfile, updatedate entrypoint, update docker compose 2024-09-26 15:08:31 -07:00
go.mod Update module connectrpc.com/connect to v1.17.0 2024-09-21 00:01:34 +00:00
go.sum Update module connectrpc.com/connect to v1.17.0 2024-09-21 00:01:34 +00:00
LICENSE [FORGEJO] branding 2023-08-23 16:03:12 +02:00
main.go Refactor to new framework (#98) 2023-04-04 21:32:04 +08:00
Makefile up go version in Makefile 2024-06-25 08:27:16 +02:00
README.md Upgrade the default container to node:20 2024-06-07 11:41:14 +02:00
RELEASE-NOTES.md chore: update the 3.5.2 release notes 2024-09-15 16:26:12 +02:00
renovate.json chore(renovate): disable replaced nektos/act 2024-08-27 09:00:08 +02:00

Forgejo Runner

WARNING: this is alpha release quality code and should not be considered secure enough to deploy in production.

A daemon that connects to a Forgejo instance and runs jobs for continous integration. The installation and usage instructions are part of the Forgejo documentation.

Reporting bugs

When filing a bug in the issue tracker, it is very helpful to propose a pull request in the end-to-end tests 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). 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).

Hacking

The Forgejo runner depends on a fork of ACT and is a dependency of the setup-forgejo action. See the full dependency graph for a global view.

Local debug

The repositories are checked out in the same directory:

Install dependencies

The dependencies are installed manually or with:

setup-forgejo/forgejo-dependencies.sh

Build the Forgejo runner with the local ACT

The Forgejo runner is rebuilt with the ACT directory by changing the runner/go.mod file to:

replace github.com/nektos/act => ../act

Running:

cd runner ; go mod tidy

Building:

cd runner ; rm -f forgejo-runner ; make forgejo-runner

Launch Forgejo and the runner

A Forgejo instance is launched with:

cd setup-forgejo
./forgejo.sh setup
firefox $(cat forgejo-url)

The user is root with password admin1234. The runner is registered with:

cd setup-forgejo
docker exec --user 1000 forgejo forgejo actions generate-runner-token > forgejo-runner-token
../runner/forgejo-runner register --no-interactive --instance "$(cat forgejo-url)" --name runner --token $(cat forgejo-runner-token) --labels docker:docker://node:20-bullseye,self-hosted:host://-self-hosted,lxc:lxc://debian:bullseye

And launched with:

cd setup-forgejo ; ../runner/forgejo-runner --config runner-config.yml daemon

Note that the runner-config.yml is required in that particular case to configure the network in bridge mode, otherwise the runner will create a network that cannot reach the forgejo instance.

Try a sample workflow

From the Forgejo web interface, create a repository and add the following to .forgejo/workflows/try.yaml. It will launch the job and the result can be observed from the actions tab.

on: [push]
jobs:
  ls:
    runs-on: docker
    steps:
      - uses: actions/checkout@v3
      - run: |
          ls ${{ github.workspace }}