Skip to content
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.

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

Improved logging on GitHub Actions runners (using log folding commands) #2414

Merged
merged 2 commits into from
Nov 15, 2023

Conversation

cmaglie
Copy link
Member

@cmaglie cmaglie commented Nov 10, 2023

Please check if the PR fulfills these requirements

See how to contribute

  • The PR has no duplicates (please search among the Pull Requests
    before creating one)
  • The PR follows
    our contributing guidelines
  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been added / updated (for bug fixes / features)
  • UPGRADING.md has been updated with a migration guide (for breaking changes)
  • configuration.schema.json updated if new parameters are added.

What kind of change does this PR introduce?

  • Adds logs folding in GH-actions runners, to improve the readability of logs.
  • Remove the -v flags from go build command to avoid printing hundreds of package name being build, clogging up the log with useless information.

What is the current behavior?

What is the new behavior?

image

Does this PR introduce a breaking change, and is titled accordingly?

Other information

https://docs.github.com/en/actions/using-workflows/workflow-commands-for-github-actions#grouping-log-lines

@cmaglie cmaglie added type: enhancement Proposed improvement topic: infrastructure Related to project infrastructure labels Nov 10, 2023
@cmaglie cmaglie self-assigned this Nov 10, 2023
Copy link

codecov bot commented Nov 13, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (17f0189) 67.15% compared to head (e887512) 67.16%.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #2414      +/-   ##
==========================================
+ Coverage   67.15%   67.16%   +0.01%     
==========================================
  Files         210      210              
  Lines       20523    20523              
==========================================
+ Hits        13782    13785       +3     
+ Misses       5602     5600       -2     
+ Partials     1139     1138       -1     
Flag Coverage Δ
unit 67.16% <ø> (+0.01%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

see 1 file with indirect coverage changes

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

Copy link
Contributor

@alessio-perugini alessio-perugini left a comment

Choose a reason for hiding this comment

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

🤩 Wow I didn't know this feature of GA!
Should we also remove the -v flag from the tests? Without that flag, only failing tests should print in the log.

  go:test:
    desc: Run unit tests and the Go-based integration tests
    deps:
      - task: go:build
    dir: '{{default "./" .GO_MODULE_PATH}}'
    cmds:
      - |
        go test \
          -v \ <------- remove this?
          -short \
          -run '{{default ".*" .GO_TEST_REGEX}}' \
          {{default "-timeout 20m -coverpkg=./... -covermode=atomic" .GO_TEST_FLAGS}} \
          -coverprofile=coverage_unit.txt \
          {{default .DEFAULT_GO_PACKAGES .GO_PACKAGES}} \
          {{.TEST_LDFLAGS}}

@umbynos
Copy link
Contributor

umbynos commented Nov 13, 2023

Amazing!! 📁

@cmaglie
Copy link
Member Author

cmaglie commented Nov 15, 2023

Should we also remove the -v flag from the tests? Without that flag, only failing tests should print in the log.

That would be the optimal solution, but I like to have the full logs available.
BTW I'm merging this one as is for now, I'd like to see if I can report errors in the "summary" page with this: https://docs.github.com/en/actions/using-workflows/workflow-commands-for-github-actions#setting-an-error-message

@cmaglie cmaglie merged commit 976e06f into arduino:master Nov 15, 2023
107 checks passed
@cmaglie cmaglie deleted the gh-action-tags branch November 15, 2023 14:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
topic: infrastructure Related to project infrastructure type: enhancement Proposed improvement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants