ci: add note about debugging to README (#141)

canonical · Aug 6, 2024 · f88f978 · f88f978
2 parents 35dc5a1 + 1a39b71
commit f88f978
Showing 1 changed file with 9 additions and 0 deletions.
diff --git a/mir-ci/readme.md b/mir-ci/readme.md
@@ -44,3 +44,12 @@ This runs internal tests.
 
 And to run it before each commit:
 `pre-commit install`
+
+## To debug runs in GitHub Actions
+1. restart a failing run, checking the "Enable debug logging" box
+2. wait for any step to fail
+3. find the tmate connection details in the job logs:
+   ```
+   Web shell: https://tmate.io/t/...
+   SSH: ssh ...@xxx.tmate.io
+   ```