diff --git a/README.md b/README.md index c156a0e..635046d 100644 --- a/README.md +++ b/README.md @@ -35,5 +35,40 @@ for an example ## Development +It is possible to refer to a local version of an workflow in the `uses:` clause +for testing purposes: + + ``` + ... + uses: './../workflows/.gitea/workflows/simple-container.yaml + ... + ``` + To avoid caching issues always tag a new version and refer to the respective -version with the tag in the consuming workflow. \ No newline at end of file +version with the tag in the consuming workflow. + +## act-runner + +I use `act_runner` to execute builds on the build server. It is possible +to test workflows by downloading a version from [gitea.com/gitea/act_runner/releases](https://gitea.com/gitea/act_runner/releases). +Following are a few use cases that might be helpful for testing: + + ``` + # Default command for running the first workflow matching a push even + act-runner exec \ + --artifact-server-path build \ # where to store artifacts + --secret "GIT_TOKEN=${GITEA_TOKEN}" \ # access token for Gitea access + --secret "PASSWORD=${PASSWORD}" \ # to pull the img-builder images + --privileged \ # needed for building containers + --env "GITEA_IP_ADDR=72.74.26.168" \ # need on my ADI mac to resolve the gitea address + --container-daemon-socket /run/docker.sock # location of the podman socket + + # When testing a tag push + act-runner exec --privileged --secret GIT_TOKEN=$GITEA_TOKEN --secret PASSWORD=$PASSWORD --artifact-server-path ./build --env "GITHUB_REFS=rests/tags/...." + + # to run a particular workflow + act-runner exec --privileged --secret GIT_TOKEN=$GITEA_TOKEN --secret PASSWORD=$PASSWORD --artifact-server-path ./build -W .gitea/workflows/test.yaml + + # To test a particular event + act-runner exec --privileged --secret GIT_TOKEN=$GITEA_TOKEN --secret PASSWORD=$PASSWORD --artifact-server-path ./build -E workfow_dispatch + ```