Skip to content

1204 Reduce unnecessary logs and prints when running the examples#1205

Merged
HenrZu merged 2 commits intomainfrom
1204-Reduce-logs-from-examples-in-CI
Feb 17, 2025
Merged

1204 Reduce unnecessary logs and prints when running the examples#1205
HenrZu merged 2 commits intomainfrom
1204-Reduce-logs-from-examples-in-CI

Conversation

@HenrZu
Copy link
Contributor

@HenrZu HenrZu commented Feb 13, 2025

Changes and Information

Please briefly list the changes (main added features, changed items, or corrected bugs) made:

  • Remove unnecessary logs/prints in the example dir which leads to an chaotic CI log for the example runs
  • CI is now faster and clearer
  • before 16.355 lines / ~110sec runtime -> now: 950 lines / 45sec runtime (release, min)

If need be, add additional information and what the reviewer should look out for in particular:

Merge Request - Guideline Checklist

Please check our git workflow. Use the draft feature if the Pull Request is not yet ready to review.

Checks by code author

  • Every addressed issue is linked (use the "Closes #ISSUE" keyword below)
  • New code adheres to coding guidelines
  • No large data files have been added (files should in sum not exceed 100 KB, avoid PDFs, Word docs, etc.)
  • Tests are added for new functionality and a local test run was successful (with and without OpenMP)
  • Appropriate documentation for new functionality has been added (Doxygen in the code and Markdown files if necessary)
  • Proper attention to licenses, especially no new third-party software with conflicting license has been added
  • (For ABM development) Checked benchmark results and ran and posted a local test above from before and after development to ensure performance is monitored.

Checks by code reviewer(s)

  • Corresponding issue(s) is/are linked and addressed
  • Code is clean of development artifacts (no deactivated or commented code lines, no debugging printouts, etc.)
  • Appropriate unit tests have been added, CI passes, code coverage and performance is acceptable (did not decrease)
  • No large data files added in the whole history of commits(files should in sum not exceed 100 KB, avoid PDFs, Word docs, etc.)
  • On merge, add 2-5 lines with the changes (main added features, changed items, or corrected bugs) to the merge-commit-message. This can be taken from the briefly-list-the-changes above (best case) or the separate commit messages (worst case).

@HenrZu HenrZu linked an issue Feb 13, 2025 that may be closed by this pull request
2 tasks
@HenrZu HenrZu changed the title 1204 Reduce logs in CI when running the examples 1204 Reduce logs and prints in CI when running the examples Feb 13, 2025
@HenrZu HenrZu changed the title 1204 Reduce logs and prints in CI when running the examples 1204 Reduce logs and prints when running the examples Feb 13, 2025
@HenrZu HenrZu changed the title 1204 Reduce logs and prints when running the examples 1204 Reduce unnecessary logs and prints when running the examples Feb 13, 2025
@codecov
Copy link

codecov bot commented Feb 13, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 97.13%. Comparing base (34a0277) to head (603c299).
Report is 3 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1205   +/-   ##
=======================================
  Coverage   97.13%   97.13%           
=======================================
  Files         149      149           
  Lines       13999    13999           
=======================================
  Hits        13598    13598           
  Misses        401      401           

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

@HenrZu HenrZu requested a review from reneSchm February 13, 2025 12:08
@HenrZu HenrZu requested a review from reneSchm February 14, 2025 12:35
Copy link
Member

@reneSchm reneSchm left a comment

Choose a reason for hiding this comment

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

Code looks okay, but

Also this should maybe be added to the PR template.

is not addressed here, so this PR does not resolve the linked issue.

@HenrZu
Copy link
Contributor Author

HenrZu commented Feb 17, 2025

Code looks okay, but

Also this should maybe be added to the PR template.

is not addressed here, so this PR does not resolve the linked issue.

Good comment. Thank you for the review.
I added to the coding guidelines:
Avoid producing unnecessarily long outputs. Ensure that all output is concise and limited to relevant information.

I decided against including this in the template because I don't want to overload it.

@HenrZu HenrZu merged commit cc6ed9d into main Feb 17, 2025
58 checks passed
@HenrZu HenrZu deleted the 1204-Reduce-logs-from-examples-in-CI branch February 17, 2025 13:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Reduce logs in CI when running the examples

2 participants