From 35e971ce3ce2fd0f7e0e31ee92e663608cb342e6 Mon Sep 17 00:00:00 2001 From: Vassil Vassilev Date: Tue, 2 Jan 2024 18:46:26 +0000 Subject: [PATCH] [ci] Open tmate if we rerun with debug logging checked. --- .github/workflows/ci.yml | 4 ++-- docs/userDocs/source/user/DevelopersDocumentation.rst | 3 ++- 2 files changed, 4 insertions(+), 3 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 5867bdf10..8cbe5b6b1 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -847,10 +847,10 @@ jobs: cat obj/CMakeCache.txt cat obj/CMakeFiles/*.log - name: Setup tmate session - if: ${{ failure() }} + if: ${{ runner.debug }} uses: mxschmitt/action-tmate@v3 # When debugging increase to a suitable value! - timeout-minutes: ${{ github.event.pull_request && 1 || 20 }} + timeout-minutes: 30 - name: Prepare code coverage report if: ${{ success() && (matrix.coverage == true) }} run: | diff --git a/docs/userDocs/source/user/DevelopersDocumentation.rst b/docs/userDocs/source/user/DevelopersDocumentation.rst index 0f3187ef5..18e268a07 100644 --- a/docs/userDocs/source/user/DevelopersDocumentation.rst +++ b/docs/userDocs/source/user/DevelopersDocumentation.rst @@ -232,7 +232,8 @@ and sometimes it may not be even feasible to replicate the GitHub runner environ For cases like these, we can directly ssh into the Github runner and debug the codebase there itself, thus saving a lot of time in replicating the Github runner environment. -To ssh into the GitHub runner on which tests are failing, increase the value of +To ssh into the GitHub runner on which tests are failing, click on re-run actions +and select the debug logging checkbox. If necessary increase the value of ``timeout-minutes`` key in ``.github/workflows/ci.yml`` to a suitable value for debugging -- 30 - 60 minutes should generally be enough.