Group GitHub Actions logging messages #235
Open
+20
−5
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
SimonLiu423
force-pushed
the
cicd/group-test-output
branch
from
6ba228c to
2fa9dde
Compare
jserv
reviewed
Mar 6, 2025
Previously, the workflow used to test the code does not group log
messages, possibly making the output too lengthy and hard to scroll on
the web. Especially the logs generated by dudect/fixture.c, although
it shows perfectly fine on local machines by rewriting previous lines
in the terminal, github actions does not seem to support it.
The log grouping is done by adding "::group::{title}" and
"::endgroup::" which are mentioned in github docs. Another argument
"--group-output" is added to "scripts/driver.py" to optionally enable
grouping. Added another target "test_ga" in "Makefile" and replaced
"make test" with it in github workflow. ("ga" is the abbreviation for
"github actions")
Link: https://docs.github.com/en/actions/writing-workflows/choosing-what-your-workflow-does/workflow-commands-for-github-actions#grouping-log-lines
Change-Id: I77d4455967b6d7e1d118049d91e67346f6dcdc1a
SimonLiu423
force-pushed
the
cicd/group-test-output
branch
from
2fa9dde to
8ed2959
Compare
Target "test_ga" for dedicated test workflow is removed. Instead, check if environment variable GITHUB_ACTIONS is set to detect which environment is running the test. GITHUB_ACTIONS is set to "true" automatically when running CI workflow on github actions. It is documented in the link below. Link: https://docs.github.com/en/actions/writing-workflows/choosing-what-your-workflow-does/store-information-in-variables#default-environment-variables Change-Id: I9359514623d96dfa387524a67c9de34d94b87c5c
SimonLiu423
force-pushed
the
cicd/group-test-output
branch
from
8ed2959 to
46cad73
Compare
jserv
reviewed
Mar 12, 2025
Comment on lines
+65
to
+69
| $(Q)if [ -n "$$GITHUB_ACTIONS" ]; then \ | ||
| scripts/driver.py -c --group-output; \ | ||
| else \ | ||
| scripts/driver.py -c; \ | ||
| fi |
There was a problem hiding this comment.
Don't do this. The test driver should be aware of the environments.
jserv
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Previously, the workflow used to test the code does not group log messages, possibly making the output too lengthy and hard to scroll on the web. Especially the logs generated by
dudect/fixture.c, although it shows perfectly fine on local machines by rewriting previous lines in the terminal, github actions does not seem to support it.The log grouping is done by adding
::group::{title}and::endgroup::which are mentioned in github docs. Another argument--group-outputis added toscripts/driver.pyto optionally enable grouping. Added another targettest_gain Makefile and replacedmake testwith it in github workflow. ("ga" is the abbreviation for "github actions")