1
0
Fork 0
mirror of https://code.forgejo.org/forgejo/runner.git synced 2025-09-15 18:57:01 +00:00

chore(docs): add building instructions (#632)

Closes forgejo/runner#290

Reviewed-on: https://code.forgejo.org/forgejo/runner/pulls/632
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>
This commit is contained in:
Earl Warren 2025-07-02 09:39:44 +00:00 committed by earl-warren
parent 5b6fb295b5
commit c9e4c0e5f3
No known key found for this signature in database
GPG key ID: F128CBE6AB3A7201

View file

@ -22,6 +22,13 @@ Work may be in progress for other architectures and you can browse the correspon
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. 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.
## Building
- Install [Go](https://go.dev/doc/install) and `make(1)`
- `make build`
The [test workflow](.forgejo/workflows/test.yml) is a full example that builds the binary, runs the tests and launches the runner binary against a live Forgejo instance.
## Local debug ## Local debug
The repositories are checked out in the same directory: The repositories are checked out in the same directory:
@ -98,7 +105,7 @@ jobs:
ls: ls:
runs-on: docker runs-on: docker
steps: steps:
- uses: actions/checkout@v3 - uses: actions/checkout@v4
- run: | - run: |
ls ${{ github.workspace }} ls ${{ github.workspace }}
``` ```