Skip to content

Use GitHub Actions diagnostics flag in CI #453

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

Open
wants to merge 8 commits into
base: main
Choose a base branch
from
Open

Use GitHub Actions diagnostics flag in CI #453

Changes from 3 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
a54d2b5
Use ACTIONS_RUNNER_DEBUG for diagnostics flag
Arlodotexe Jul 9, 2024
641976c
Merge branch 'main' into ci/diagnostics/debug-logging
Arlodotexe Jul 9, 2024
aa91144
Use github instead of env for ACTIONS_RUNNER_DEBUG flag
Arlodotexe Jul 9, 2024
2f3e626
Update .github/workflows/build.yml
michael-hawker Jul 11, 2024
0b50ad7
Update .github/workflows/build.yml
Arlodotexe Jul 11, 2024
f4653a2
Use runner.debug flag for diagnostics
Arlodotexe Jul 24, 2024
4b98b36
Merge branch 'main' into ci/diagnostics/debug-logging
Arlodotexe Jan 4, 2025
08318c1
Use ACTIONS_RUNNER_DEBUG instead of ENABLE_DIAGNOSTICS
Arlodotexe Jan 4, 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
2 changes: 1 addition & 1 deletion .github/workflows/build.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ on:

env:
DOTNET_VERSION: ${{ '8.0.201' }}
ENABLE_DIAGNOSTICS: true
ENABLE_DIAGNOSTICS: ${{ github.ACTIONS_RUNNER_DEBUG }}
Copy link
Member

Choose a reason for hiding this comment

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

Hmm, doesn't seem to be picking it up, should it just be a straight ACTIONS_RUNNER_DEBUG or secrets.ACTIONS_RUNNER_DEBUG ?

Copy link
Member

Choose a reason for hiding this comment

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

Oh, just found this, it may just be ${{ runner.debug }} https://stackoverflow.com/questions/75434105/how-to-determine-if-the-github-action-is-running-with-debug-logging-enabled

From runner context doc - https://docs.github.com/en/actions/learn-github-actions/contexts#runner-context - this seems to be what corresponds to the checkbox. Not sure what that other doc is about...

We should update the comment too

Copy link
Member Author

@Arlodotexe Arlodotexe Jul 11, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

Looking at the originally linked docs, I think I see why ACTIONS_RUNNER_DEBUG didn't enable verbose logging. From the docs:

Runner diagnostic logging provides additional log files that contain information about how a runner is executing a job. Two extra log files are added to the log archive:

  • The runner process log, which includes information about coordinating and setting up runners to execute jobs.
  • The worker process log, which logs the execution of a job.

Maybe we need to enable step debug logging instead via ACTIONS_STEP_DEBUG, which:

  • increases the verbosity of a job's logs during and after a job's execution.

As for the runner.debug context value, the docs for this seem to point to the same docs used before 🤔

We can try both, but let's start with ACTIONS_STEP_DEBUG and see if that works.

Copy link
Member Author

Choose a reason for hiding this comment

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

Suggested change
ENABLE_DIAGNOSTICS: ${{ github.ACTIONS_RUNNER_DEBUG }}
ENABLE_DIAGNOSTICS: ${{ github.ACTIONS_STEP_DEBUG }}

Copy link
Member Author

Choose a reason for hiding this comment

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

Looks like ACTIONS_STEP_DEBUG didn't do it either, let's try runner.debug then

Copy link
Member Author

Choose a reason for hiding this comment

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

Posted here as well, but runner.debug didn't work as expected. runner isn't recognized.

MSBUILD_VERBOSITY: normal
#COREHOST_TRACE: 1
COREHOST_TRACEFILE: corehosttrace.log
Expand Down