docs: how to test gha (#13056)

alevenberg · web-flow · commit cbb87dc375fe · 2023-11-06T21:53:05.000Z
diff --git a/doc/contributor/howto-guide-test-gha.md b/doc/contributor/howto-guide-test-gha.md
@@ -0,0 +1,24 @@
+# How-to Guide: Test Github Actions (GHA)
+
+Our GHA configurations live in `.github/workflows`.
+
+We have 4 actions that run our builds on Windows and MacOS.
+
+- `macos-bazel.yml`
+- `macos-cmake.yml`
+- `windows-bazel.yml`
+- `windows-cmake.yml`
+
+To test changes to one of those GHA, you need to push it to a branch on the
+upstream repo (googleapis/google-cloud-cpp) with the prefix `ci-gha`
+
+```shell
+git checkout -b ci-gha-XXX
+git push -u upstream
+```
+
+Then delete the branch on the upstream repo when you're done
+
+```shell
+git push upstream --delete <branch>
+```
