Skip to content

feat: detect ACTIONS_RUNNER_DEBUG env var #174

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

Jump to bottom
Merged
2bndy5 merged 1 commit into from
Dec 23, 2025
Merged

feat: detect ACTIONS_RUNNER_DEBUG env var #174

2bndy5 merged 1 commit into from
Dec 23, 2025

Conversation

@2bndy5
Copy link
Contributor

@2bndy5 2bndy5 commented Dec 22, 2025 •
edited by coderabbitai bot
Loading

To auto-enable debug logs output when re-running jobs with "debug logging" enabled.

ref GH docs

Summary by CodeRabbit

  • Bug Fixes
    • Improved debug flag detection to recognize additional environment variables for enabling debug mode, making debug functionality more flexible across different environments.

✏️ Tip: You can customize this high-level summary in your review settings.

@2bndy5
feat: detect ACTIONS_RUNNER_DEBUG env var
7e62176 
To auto-enable debug logs output when re-running jobs with "debug logging" enabled.

ref [GH docs](https://docs.github.com/en/actions/how-tos/monitor-workflows/enable-debug-logging)
@coderabbitai
Copy link

coderabbitai bot commented Dec 22, 2025

Walkthrough

The debug flag evaluation in GithubApiClient.__init__ is modified to check both ACTIONS_STEP_DEBUG and ACTIONS_RUNNER_DEBUG environment variables. Previously, only ACTIONS_STEP_DEBUG was evaluated; now the debug flag is enabled if either variable is set to "true".

Changes

Cohort / File(s) Change Summary
Debug flag evaluation expansion
cpp_linter/rest_api/github_api.py		 Modified condition in GithubApiClient.__init__ to evaluate debug state using OR logic across two environment variables (ACTIONS_STEP_DEBUG and ACTIONS_RUNNER_DEBUG) instead of only checking ACTIONS_STEP_DEBUG.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)
Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. You can run @coderabbitai generate docstrings to improve docstring coverage.
✅ Passed checks (2 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The pull request title directly and accurately describes the main change: adding detection of the ACTIONS_RUNNER_DEBUG environment variable in the GitHub API client.
✨ Finishing touches
  • 📝 Generate docstrings
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch auto-debug-logs
📜 Recent review details

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 7885064 and 7e62176.

📒 Files selected for processing (1)
  • cpp_linter/rest_api/github_api.py
⏰ 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). (2)
  • GitHub Check: Codacy Static Code Analysis
  • GitHub Check: auto-label
🔇 Additional comments (1)
cpp_linter/rest_api/github_api.py (1)

60-63: Implementation is correct.

The logic properly enables debug mode when either ACTIONS_STEP_DEBUG or ACTIONS_RUNNER_DEBUG is set to "true". Both ACTIONS_RUNNER_DEBUG and ACTIONS_STEP_DEBUG are official GitHub Actions variables that can be set to enable diagnostic logging, and the string comparison to lowercase "true" matches GitHub's specification.

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

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

@2bndy5 2bndy5 mentioned this pull request Dec 22, 2025
Closed
@codecov
Copy link

codecov bot commented Dec 23, 2025 •
edited
Loading

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 98.25%. Comparing base (7885064) to head (7e62176).
⚠️ Report is 2 commits behind head on main.

Additional details and impacted files 
@@           Coverage Diff           @@
##             main     #174   +/-   ##
=======================================
  Coverage   98.25%   98.25%           
=======================================
  Files          23       23           
  Lines        1896     1896           
=======================================
  Hits         1863     1863           
  Misses         33       33

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@2bndy5 2bndy5 merged commit 58cb347 into main Dec 23, 2025
43 checks passed
@2bndy5 2bndy5 deleted the auto-debug-logs branch December 23, 2025 03:30
@shenxianpeng shenxianpeng added the enhancement New feature or request label Dec 23, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@shenxianpeng shenxianpeng shenxianpeng approved these changes

Assignees

No one assigned

Labels

enhancement New feature or request

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@2bndy5 @shenxianpeng