CI: Clearer instructions on how to shell into a GH Actions session (#4121)

diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
index 57740548e17fae76e14225f03611f0f89c5afbd3..b5e16baf8b6b65d23fbe79368d870859be90dd0e 100644 (file)
--- a/.github/workflows/ci.yml
+++ b/.github/workflows/ci.yml
@@ -319,8 +319,24 @@ jobs:
       if: ${{ matrix.env.TEST_TYPE == 'fuzzing' && failure() }}
 
     #
-    #  If the CI has failed and the branch is ci-debug then start a tmate
-    #  session. SSH rendezvous point is emited continuously in the job output.
+    #  If the CI has failed and the branch is ci-debug then we start a tmate
+    #  session to provide interactive shell access to the session.
+    #
+    #  The SSH rendezvous point will be emited continuously in the job output,
+    #  which will look something like:
+    #
+    #      SSH: ssh VfuX8SrNuU5pGPMyZcz7TpJTa@sfo2.tmate.io
+    #
+    #  For example:
+    #
+    #      git push origin ci-debug --force
+    #
+    #  Look at the job output in: https://github.com/FreeRADIUS/freeradius-server/actions
+    #
+    #      ssh VfuX8SrNuU5pGPMyZcz7TpJTa@sfo2.tmate.io
+    #
+    #  Access requires that you have the private key corresponding to the
+    #  public key of the GitHub user that initiated the job.
     #
     - name: "Debug: Start tmate"
       uses: mxschmitt/action-tmate@v3