diff options
author | earl-warren <earl-warren@noreply.code.forgejo.org> | 2024-05-21 13:13:51 +0200 |
---|---|---|
committer | earl-warren <earl-warren@noreply.code.forgejo.org> | 2024-05-21 13:13:51 +0200 |
commit | 0bacffa87ec7a29fa73a855f2aeadf7bb2f78a9c (patch) | |
tree | 664fc79c5aa6f3e7a88f8145adbbf8688c90c107 | |
parent | Add opencontainer labels to container (#195) (diff) | |
parent | README: explain how end-to-end tests help with reporting bugs (diff) | |
download | forgejo-runner-0bacffa87ec7a29fa73a855f2aeadf7bb2f78a9c.tar.xz forgejo-runner-0bacffa87ec7a29fa73a855f2aeadf7bb2f78a9c.zip |
Merge pull request 'README: explain how end-to-end tests help with reporting bugs' (#163) from earl-warren/runner:wip-readme into main
Reviewed-on: https://code.forgejo.org/forgejo/runner/pulls/163
-rw-r--r-- | README.md | 4 |
1 files changed, 4 insertions, 0 deletions
@@ -4,6 +4,10 @@ A daemon that connects to a Forgejo instance and runs jobs for continous integration. The [installation and usage instructions](https://forgejo.org/docs/next/admin/actions/) are part of the Forgejo documentation. +# Reporting bugs + +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)). + # 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. |