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

add input variable for generating workflow summary #126

Merged
merged 3 commits into from Sep 3, 2023

Conversation

eransamo
Copy link
Contributor

@eransamo eransamo commented Sep 3, 2023

Summary

Add input variable to enable suppressing the logging of coverage to workflow job summary.

Closing Issues

Closes #127

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Improvements to existing code, such as refactoring or optimizations (non-breaking)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • I have read the CONTRIBUTING document.
  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have added tests to cover my changes.
  • All new and existing tests passed.

@eransamo
Copy link
Contributor Author

eransamo commented Sep 3, 2023

when using custom multi-project github actions using the .py script, summary becomes very long

Screenshot 2023-09-03 at 17 45 08

When running in CLI mode, the markdown summary isn't output. So the new argument isn't needed for that case.
@cicirello cicirello added the enhancement New feature or request label Sep 3, 2023
@cicirello
Copy link
Owner

@eransamo thank you for the contribution. I'm going to merge this soon (after PR checks are done running). I made one minor edit to the CLI mode case. In CLI mode, it doesn't output the workflow job summary (e.g., would be weird to output markdown to the console to begin with), so I just got rid of the new argument in that case and hardcoded False.

@cicirello cicirello merged commit f0dd6f6 into cicirello:main Sep 3, 2023
3 checks passed
@cicirello
Copy link
Owner

@eransamo I completed the merge. I'll probably create a new release tomorrow.

@eransamo
Copy link
Contributor Author

eransamo commented Sep 4, 2023

thanks @cicirello ! sounds great

@cicirello
Copy link
Owner

@eransamo this is now live in version v2.10.0 (or through the major release tag v2). 🚀

@eransamo
Copy link
Contributor Author

eransamo commented Sep 6, 2023

works great @cicirello ! no issues and summaries are not added

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Option to suppress logging output to workflow job summary
2 participants