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

Reduced MsBuild log output and consistent use of [Reqnroll] prefix #381

Merged
merged 5 commits into from
Jan 10, 2025

Conversation

obligaron
Copy link
Contributor

🤔 What's changed?

  • Changed the default log level of reqnroll MsBuild messages to normal or low.
  • Used [Reqnroll] prefix for all generated messages.
  • Removed unused log related MSBuild configurations.
  • Added an extra entry in the Troubleshooting section to highlight the additional logging option.

⚡️ What's your motivation?

When generating a project with many feature files, Reqnroll will generate many log entries even if minimal logging is configured.
However, the logging guidelines state that only high importance messages should be logged when minimal detail is specified.
The detailed output happens because we currently always set a `VerboseOutput' MSBuild property to true. This has been happening since commit 828da0d and is probably an unintentional change (verbose should not be enabled by default).

🏷️ What kind of change is this?

  • 📖 Documentation (improvements without changing code)
  • 🏦 Refactoring/debt/DX (improvement to code design, tooling, etc. without changing behaviour)

♻️ Anything particular you want feedback on?

📋 Checklist:

  • My change requires a change to the documentation.
    • I have updated the documentation accordingly.
  • Users should know about my change
    • I have added an entry to the "[vNext]" section of the CHANGELOG, linking to this pull request & included my GitHub handle to the release contributors list.

@gasparnagy
Copy link
Contributor

This is cool. I will play with it a bit tomorrow and then merge.

Copy link
Contributor

@gasparnagy gasparnagy left a comment

Choose a reason for hiding this comment

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

thx!

@gasparnagy gasparnagy merged commit e133a57 into main Jan 10, 2025
5 checks passed
@gasparnagy gasparnagy deleted the msbuildlog branch January 10, 2025 10:31
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