From c33cf2f428f78b52a70a8df438dfc2d8cdbe3ece Mon Sep 17 00:00:00 2001 From: evanchooly Date: Sun, 5 Jan 2025 21:50:23 -0500 Subject: [PATCH] add a note for running locally --- README.md | 20 +++++++++++++++++++- 1 file changed, 19 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 98056f3..e5a6771 100644 --- a/README.md +++ b/README.md @@ -16,4 +16,22 @@ needs a little tweaking, like morphia's does, you can copy build.sh in to your p > [!NOTE] > This build assumes a maven based build because that's what I use. If you use gradle, or heaven forfend, something else, you'll need -> to provide your own `build.sh` in your project's folder to build/run properly. \ No newline at end of file +> to provide your own `build.sh` in your project's folder to build/run properly. + +If you would like to use this framework to test your own project but can't, for whatever, go the pull request route (maybe your project is +private so it's invisible from this project), you have a couple of options. Make the changes listed above. You can either fork the +project and run the actions under your own credentials/org or you can simply run it manually locally with the `test-local.sh` script like so: + +```shell +./test-local.sh myprivateproject +``` + +This is run it all in the local filesystem. If you have [act](https://github.com/nektos/act) installed (in this case, it's installed as +an [extension]() to github's `gh` tool), you can run it locally like this: + +```shell +gh act --matrix project:myprivateproject | grep -vE "::debug::" +``` + +> [!NOTE] +> You will need docker installed for this to work. The grep isn't entirely necessary but act (currently) emits a lot of debug statements that tend to occlude any useful information coming out of the action run.