feat: better customize header in step reports (through .get_step_report(header=...)#142
Merged
rich-iannone merged 8 commits intomainfrom Apr 3, 2025
Merged
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #142 +/- ##
=======================================
Coverage 99.14% 99.14%
=======================================
Files 17 17
Lines 3721 3739 +18
=======================================
+ Hits 3689 3707 +18
Misses 32 32 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
This file contains hidden or 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
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.
This PR makes a second attempt to better let the user customize the header in a step report. Previously, the
header=arg would accept text that would completely replace the header. However, the header in a step report consists of a title element and a larger details element. You couldn't replace only the title portion without wiping out the details part in the process.Here, we allow for use of templating, where the default template is
"{title}{details}"(andheader=":default:"calls up this standard template). If you wanted to replace the title and keep the details, you'd supply"Custom Title {details}". Here's an example:Fixes: #111