1
0
Fork 0
mirror of https://code.forgejo.org/forgejo/runner.git synced 2025-09-15 18:57:01 +00:00
Forgejo runner - alpha release, should not be considered secure enough to deploy in production
Find a file
Earl Warren 660e24bff5
fix: the vars context is allowed in an action step env (#761)
the actions schema validation must not fail when using an
expression such as:

```yaml
runs:
  using: composite
  steps:
    - name: Build the container image for each architecture
      env:
        BUILDKIT_HOST: ${{ vars.BUILDKIT_HOST }}
      run: buildkit-build.sh
```

---

Without the fix, the test fails with:

```
go test -run=TestActionSchema -v ./act/schema
=== RUN   TestActionSchema
    schema_test.go:153:
        	Error Trace:	/home/earl-warren/software/runner/act/schema/schema_test.go:153
        	Error:      	Received unexpected error:
        	            	Line: 14 Column 3: Failed to match container-runs: Line: 15 Column 3: Unknown Property steps
        	            	Line: 14 Column 3: Failed to match node-runs: Line: 15 Column 3: Unknown Property steps
        	            	Line: 14 Column 3: Failed to match plugin-runs: Line: 14 Column 3: Unknown Property using
        	            	Line: 15 Column 3: Unknown Property steps
        	            	Line: 14 Column 3: Failed to match composite-runs: Line: 16 Column 7: Failed to match run-step: Line: 19 Column 18: Unknown Variable Access vars
        	            	Line: 16 Column 7: Failed to match uses-step: Line: 16 Column 7: Unknown Property run
        	            	Line: 19 Column 18: Unknown Variable Access vars
        	Test:       	TestActionSchema
--- FAIL: TestActionSchema (0.00s)
FAIL
FAIL	code.forgejo.org/forgejo/runner/act/schema	0.003s
FAIL
```

---

<!--start release-notes-assistant-->
<!--URL:https://code.forgejo.org/forgejo/runner-->
- bug fixes
  - [PR](https://code.forgejo.org/forgejo/runner/pulls/761): <!--number 761 --><!--line 0 --><!--description Zml4OiB0aGUgdmFycyBjb250ZXh0IGlzIGFsbG93ZWQgaW4gYW4gYWN0aW9uIHN0ZXAgZW52-->fix: the vars context is allowed in an action step env<!--description-->
<!--end release-notes-assistant-->

Reviewed-on: https://code.forgejo.org/forgejo/runner/pulls/761
Reviewed-by: Michael Kriese <michael.kriese@gmx.de>
Co-authored-by: Earl Warren <contact@earl-warren.org>
Co-committed-by: Earl Warren <contact@earl-warren.org>
2025-07-30 11:06:55 +00:00
.forgejo chore(ci): add release-notes-assistant to pull requests (take 2) 2025-07-29 12:11:37 +02:00
.github/workflows chore: s|runner.forgejo.org|code.forgejo.org/forgejo/runner| (#747) 2025-07-27 16:26:10 +00:00
act fix: the vars context is allowed in an action step env (#761) 2025-07-30 11:06:55 +00:00
contrib Fix comments in systemd unit service file (#274) 2024-09-18 13:40:32 +00:00
examples Update code.forgejo.org/oci/alpine Docker tag to v3.22 (#712) 2025-07-16 09:11:29 +00:00
internal chore: a single testutils for both act and the runner (#759) 2025-07-29 13:34:04 +00:00
scripts add instructions to run under systemd user services 2024-02-19 09:09:57 +01:00
testutils chore: a single testutils for both act and the runner (#759) 2025-07-29 13:34:04 +00: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 chore: remove unused code and comments including gitea 2025-07-03 18:58:11 +02:00
.golangci.yml chore: disable package name checks for revive [skip cascade] (#750) 2025-07-28 12:26:08 +00:00
Dockerfile Update data.forgejo.org/oci/alpine Docker tag to v3.22 (#616) 2025-06-18 05:43:57 +00:00
go.mod chore: s|github.com/nektos/act/pkg|code.forgejo.org/forgejo/runner/act| 2025-07-28 19:23:07 +02:00
go.sum chore: s|github.com/nektos/act/pkg|code.forgejo.org/forgejo/runner/act| 2025-07-28 19:23:07 +02:00
LICENSE chore: update LICENSE year 2025-07-03 18:58:11 +02:00
main.go chore: s|runner.forgejo.org|code.forgejo.org/forgejo/runner| (#747) 2025-07-27 16:26:10 +00:00
Makefile chore: make forgejo-runner depends on act sources 2025-07-28 19:47:12 +02:00
README.md chore: update the README to reflect that act is within the runner 2025-07-28 20:00:52 +02:00
RELEASE-NOTES.md chore(release-notes): finalize 9.0.0 (#756) 2025-07-29 05:38:33 +00:00
renovate.json chore: renovate must not look at any testdata subdirectory (#758) 2025-07-29 15:38:23 +00: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 continuous 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).

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.

Hacking

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

The test workflow is a full example that builds the binary, runs the tests and launches the runner binary against a live Forgejo instance.

Generate mocks

  • make deps-tools
  • make generate

If there are changes, commit them to the repository.

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

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:22-bookworm,self-hosted:host,lxc:lxc://debian:bookworm

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@v4
      - run: |
          ls ${{ github.workspace }}