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

Support for nightly code check workflow #292

Merged
merged 19 commits into from
Nov 19, 2024

Conversation

andrewmogan
Copy link
Contributor

daq-release PR #411 will add a nightly workflow which runs unit tests and clang formatting checks. In order to report the results of those tests in an easily digestible manner, this PR adds support for markdown output which can be used in GitHub step summaries.

dbt-build will now use pytee to write a "no unit tests written" message to stdout as well as the summary log. This allows the nightly code check workflow to parse this information from the unit test summary log, which previously only noted success or failure of unit tests which already exist.

dbt-clang-format.sh now has an optional command-line flag, --markdown-summary, which controls whether or not it outputs the clang formatting results to a .md file which can be used for the GitHub step summary. I also took this opportunity to improve the argument parsing in that script.

The results of the nightly code check workflow, which currently uses this branch of daq-buildtools, can be seen here.

@jcfreeman2 jcfreeman2 self-requested a review November 18, 2024 15:48
Copy link
Collaborator

@jcfreeman2 jcfreeman2 left a comment

Choose a reason for hiding this comment

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

This looks good. Two very minor requests:

  1. If "-m" is passed to dbt-clang-format.sh, at the bottom of the output could there be a statement to the effect of "clang_format_summary_table.md created"?
  2. Not sure if this technically possible, but if it is, can we reinstate the red font for the "No unit tests written for package X" statement?

@jcfreeman2
Copy link
Collaborator

Just tried to build rcif and got "No unit tests have been written for package rcif" in the desired red font; I now approve this PR. Note that, concering my other request, Andrew pointed out there's already a printout of "clang_format_summary_table.md created", I just missed it.

@jcfreeman2 jcfreeman2 merged commit 797f5f9 into develop Nov 19, 2024
@jcfreeman2 jcfreeman2 deleted the amogan/daq_release_issue405 branch November 19, 2024 16:33
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.

2 participants