summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorearl-warren <earl-warren@noreply.code.forgejo.org>2024-05-21 13:13:51 +0200
committerearl-warren <earl-warren@noreply.code.forgejo.org>2024-05-21 13:13:51 +0200
commit0bacffa87ec7a29fa73a855f2aeadf7bb2f78a9c (patch)
tree664fc79c5aa6f3e7a88f8145adbbf8688c90c107
parentAdd opencontainer labels to container (#195) (diff)
parentREADME: explain how end-to-end tests help with reporting bugs (diff)
downloadforgejo-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.md4
1 files changed, 4 insertions, 0 deletions
diff --git a/README.md b/README.md
index fe23668..aa91aa0 100644
--- a/README.md
+++ b/README.md
@@ -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.