Skip to content

Adding tmate action to CI for debugging #3138

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
paulromano merged 12 commits into from
Feb 12, 2025
Merged

Adding tmate action to CI for debugging #3138

Changes from 10 commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
d95b172
Adding tmate to CI for debugging
pshriwise Sep 20, 2024
b18f5b5
Only enable tmate if [ci-debug] is in the commit message
pshriwise Oct 10, 2024
a54cd24
Making tmate commit message trigger more robust [gha-debug]
pshriwise Oct 10, 2024
a6edfc9
Merge branch 'develop' into tmate
pshriwise Oct 10, 2024
48d2e73
Activate tmate [gha-debug]
pshriwise Oct 10, 2024
8a62aea
Trying activate tmate again [gha-debug]
pshriwise Oct 10, 2024
d97c00c
Update ci.yml [gha-debug]
pshriwise Oct 10, 2024
3e5fc2c
Using merge commit parents for PRs
pshriwise Oct 11, 2024
1be6045
Remove old echo in env var section [gha-debug]
pshriwise Oct 11, 2024
35f8dfa
Fixing a snag [gha-debug]
pshriwise Oct 14, 2024
8e1f3a8
[gha-debug]
pshriwise Oct 28, 2024
cb5889c
Adding a section to the docs on using tmate to debug CI failures
pshriwise Jan 24, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 19 additions & 1 deletion .github/workflows/ci.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,8 @@ jobs:

steps:
- uses: actions/checkout@v4
with:
fetch-depth: 2

- name: Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@v5
Expand All @@ -98,7 +100,17 @@ jobs:
run: |
echo "OPENMC_CROSS_SECTIONS=$HOME/nndc_hdf5/cross_sections.xml" >> $GITHUB_ENV
echo "OPENMC_ENDF_DATA=$HOME/endf-b-vii.1" >> $GITHUB_ENV

# get the sha of the last branch commit
# for push and workflow_dispatch events, use the current reference head
BRANCH_SHA=HEAD
# for a pull_request event, use the last reference of the parents of the merge commit
if [ "${{ github.event_name }}" == "pull_request" ]; then
BRANCH_SHA=$(git rev-list --parents -n 1 HEAD | rev | cut -d" " -f 1 | rev)
fi
COMMIT_MESSAGE=$(git log $BRANCH_SHA -1 --pretty=%B)
echo ${COMMIT_MESSAGE}
echo "COMMIT_MESSAGE=${COMMIT_MESSAGE}" >> $GITHUB_ENV

- name: Apt dependencies
shell: bash
run: |
Expand Down Expand Up @@ -153,6 +165,12 @@ jobs:
CTEST_OUTPUT_ON_FAILURE=1 make test -C $GITHUB_WORKSPACE/build/
$GITHUB_WORKSPACE/tools/ci/gha-script.sh

- name: Setup tmate debug session
continue-on-error: true
if: ${{ contains(env.COMMIT_MESSAGE, '[gha-debug]') }}
uses: mxschmitt/action-tmate@v3
timeout-minutes: 10

@ahnaf-tahmid-chowdhury ahnaf-tahmid-chowdhury Oct 24, 2024

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Doesn't it mean the session will end after 10 min? And I have noticed, when the log is huge, we can't scroll the window in tmate session. So, is there any alternative?

@pshriwise pshriwise Oct 25, 2024

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This does mean the session will close after 10 minutes, yes. I don't think we want CI running indefinitely. This seemed like a reasonable window for someone to follow the progress of CI and log into the session.

The terminal session is inside of a tool called tmux. You can scroll up higher in the terminal output, but it requires a few extra keystrokes (Ctrl+B, [ if memory serves).

@ahnaf-tahmid-chowdhury ahnaf-tahmid-chowdhury Oct 25, 2024

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you please double check this? I was testing this workflow in my branch and found that the session gets closed even when I am logged in. I think that since we are using a specific commit to run this, we can increase the time limit to 1 h.

@pshriwise pshriwise Oct 25, 2024

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hrmm I hadn't experienced that. Let me confirm and I can increase the time limit.

@paulromano paulromano Jan 24, 2025

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What was the resolution on this? Do we need to increase the timeout limit?


- name: after_success
shell: bash
run: |
Expand Down