ci: add tmate

[jost-s]

Summary by CodeRabbit

• Chores
  • Updated CI/CD workflow infrastructure.

Note: This release contains no user-facing changes. Updates are limited to development and testing processes.

[cocogitto-bot]

✔️ bff7eb2 - Conventional commits check succeeded.

[coderabbitai]

Walkthrough

Added a new CI step "Setup tmate session" using mxschmitt/action-tmate@v3 in the test workflow, positioned between the musl cargo build and Windows test steps to enable interactive debugging during CI runs.

Changes

Cohort / File(s)	Change Summary
CI/CD Configuration \.github/workflows/test\.yml	Added tmate session debugging step to enable interactive terminal access during CI runs

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

• Single workflow file modification with no impact on test logic or build behavior
• Addition of a debugging tool step with straightforward configuration

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title 'ci: add tmate' directly and accurately summarizes the main change—adding tmate to the CI workflow for interactive debugging.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch test/debug-macos

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 27fbdd1 and bff7eb2.

📒 Files selected for processing (1)

• .github/workflows/test.yml (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (7)

• GitHub Check: Test (windows-latest)
• GitHub Check: test (x86_64, 33, 26.0.10792818, go-pion)
• GitHub Check: test (x86_64, 33, 26.0.10792818, datachannel)
• GitHub Check: test (x86_64, 29, 26.0.10792818, datachannel)
• GitHub Check: test (x86_64, 29, 26.0.10792818, go-pion)
• GitHub Check: Test (macos-latest)
• GitHub Check: Test (ubuntu-latest)

[coderabbitai]

⚠️ Potential issue | 🔴 Critical

🧩 Analysis chain

🚨 Critical: tmate will block ALL CI runs indefinitely.

The mxschmitt/action-tmate@v3 action is an interactive SSH debugging session that pauses workflow execution and waits for user input. Adding it unconditionally (without an if condition) across all three matrix OS configurations will:

1. Block the test steps from ever running—workflows will hang waiting for manual input
2. Waste runner resources across all three OS platforms on every PR and commit
3. Break CI if merged to main, preventing any PRs from merging

Given the branch name test/debug-macos, this appears to be experimental. Before merging, either:

• Restrict tmate to specific conditions (e.g., if: failure() or a manual workflow_dispatch trigger)
• Remove it entirely and use a dedicated debug workflow instead
• Add a timeout via the timeout-minutes job setting to prevent indefinite hangs

Please confirm the intended use case and apply an appropriate guard condition (or remove before merge).

---

I'll verify the claims by examining the actual workflow file and researching the tmate action behavior.

---

🏁 Script executed:

#!/bin/bash
# Examine the test.yml workflow file, focusing on context around lines 55-75
cat .github/workflows/test.yml | head -80 | tail -30

Length of output: 907

---

🏁 Script executed:

#!/bin/bash
# Get full context of the tmate step and surrounding steps
cat .github/workflows/test.yml

Length of output: 2104

---

🏁 Script executed:

#!/bin/bash
# Check for any conditional statements or timeout settings in the workflow
rg -n "if:|timeout|tmate" .github/workflows/test.yml -C5

Length of output: 1431

---

🌐 Web query:

mxschmitt action-tmate behavior default timeout interaction mode

💡 Result:

• Behavior: mxschmitt/action-tmate starts a tmate session on the runner so you can SSH or use a web shell to interactively debug the job. By default the step blocks (waits) while the session is active unless you enable detached mode. [1]

• Default interaction mode: blocking (not detached). If you set with: detached: true the action starts the session and continues the workflow; the action will then wait at the end of the job for the session to end. [1]

• Default timeout behavior: if you do not set a specific timeout, the tmate session will remain open until the workflow/job times out. In detached mode there is an extra safety: if no user has connected within 10 minutes after the post-job step started, the session will be terminated. You can also set a job-level timeout using timeout-minutes on the step/job. [1]

Source: action documentation for mxschmitt/action-tmate. [1]

---

🚨 Critical: tmate will block ALL CI runs indefinitely.

The mxschmitt/action-tmate@v3 action is an interactive SSH debugging session that pauses workflow execution and waits for user input. Adding it unconditionally (without an if condition) across all three matrix OS configurations will:

1. Block the test steps from ever running—workflows will hang waiting for manual input
2. Waste runner resources across all three OS platforms on every PR and commit
3. Break CI if merged to main, preventing any PRs from merging

Given the branch name test/debug-macos, this appears to be experimental. Before merging, either:

• Restrict tmate to specific conditions (e.g., if: failure() or a manual workflow_dispatch trigger)
• Remove it entirely and use a dedicated debug workflow instead
• Add a timeout via the timeout-minutes job setting to prevent indefinite hangs

🤖 Prompt for AI Agents

.github/workflows/test.yml around lines 61-62: the workflow unconditionally adds
the interactive mxschmitt/action-tmate@v3 step which will pause CI and block
runs; to fix it either remove the tmate step from this workflow entirely, or
guard it with a conditional so it only runs for explicit debugging (for example
only on workflow_dispatch or on failure), or move it into a separate debug-only
workflow, and/or add a job-level timeout-minutes to prevent indefinite hanging;
apply one of these changes so tmate does not run unconditionally across the
matrix.