Skip to content

Conversation

@krishnakumar4a4
Copy link
Contributor

@krishnakumar4a4 krishnakumar4a4 commented Sep 3, 2025

This pull request updates and streamlines log messages throughout the build workflow in the cargo-wdk crate. The changes focus on making the output more concise and consistent, removing redundant or overly verbose details, and improving clarity in log statements.

Logging improvements:

  • Made log messages shorter wherever possible
  • Removed the Running cargo build log line that appeared before we invoke cargo
  • Removed periods at the end of log lines
  • Stopped printing Running InfVerif if we are skipping it. We print only InvVerif skipped... in that case now.
  • Moved InvVerif skipped... log line from info to warn because it refers to an event that is unusual
  • Removed the use of less precise terms like processing and replaced them with the more natural term building
  • Moved unnecessary log lines to debug level

There is still more work to do in this area. The logging for instance can be confusing when building an emulated workspace -- it may be hard know which project is which. We will make such improvements later when we refactor cargo-wdk code which is also overdue.

Here are comparisons showing the effect of this PR on various build scenarios: standalone driver, workspace and emulated workspace. The left part is the output before this PR and the right side is after the PR.

Standalone Driver Project

standalone2

Workspace

workspace2

Emulated Workspace

emulated-workspace2

@krishnakumar4a4 krishnakumar4a4 marked this pull request as ready for review September 10, 2025 03:24
Copilot AI review requested due to automatic review settings September 10, 2025 03:24
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This pull request improves logging consistency and conciseness throughout the build workflow by updating log messages across the cargo-wdk crate. The changes focus on making log output more streamlined and user-friendly while maintaining clarity about the build process status.

  • Updated log messages to use more concise and consistent phrasing
  • Simplified warning and info messages for better readability
  • Updated test assertions to match the new log message format

Reviewed Changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.

File Description
build_command_test.rs Updates test assertions to match new log message format from the build workflow
mod.rs Streamlines log messages in build orchestration, making them more concise and consistent
build_task.rs Simplifies cargo build log message to be more general and less verbose

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

@krishnakumar4a4 krishnakumar4a4 changed the title improve logging for build action refactor: improve logging for build action Sep 10, 2025
Copy link
Contributor

@gurry gurry left a comment

Choose a reason for hiding this comment

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

Added some comments. To be addressed later as we're currently not focusing on this PR.

Copy link
Contributor

@gurry gurry left a comment

Choose a reason for hiding this comment

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

We should also shorten this log line:

Processing Rust(possibly driver) project:

to this:

Processing project:

because the Rust(possible driver) part is a bit awkwardly worded and secondly not providing any useful information.

Copilot AI review requested due to automatic review settings September 30, 2025 12:17
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.


Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

gurry and others added 2 commits September 30, 2025 17:51
Co-authored-by: Copilot <[email protected]>
Signed-off-by: Gurinder Singh <[email protected]>
Copilot AI review requested due to automatic review settings September 30, 2025 12:22
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.


Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

Co-authored-by: Copilot <[email protected]>
Signed-off-by: Gurinder Singh <[email protected]>
Copilot AI review requested due to automatic review settings September 30, 2025 12:26
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

Copilot reviewed 4 out of 4 changed files in this pull request and generated no new comments.


Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

Copilot AI review requested due to automatic review settings October 1, 2025 01:52
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

Copilot reviewed 4 out of 4 changed files in this pull request and generated no new comments.


Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

Copilot AI review requested due to automatic review settings October 1, 2025 05:50
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

Copilot reviewed 5 out of 5 changed files in this pull request and generated 2 comments.


Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

Copilot AI review requested due to automatic review settings October 1, 2025 07:10
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

Copilot reviewed 5 out of 5 changed files in this pull request and generated no new comments.


Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

Copilot AI review requested due to automatic review settings October 1, 2025 09:37
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

Copilot reviewed 5 out of 5 changed files in this pull request and generated 1 comment.


Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

Copilot AI review requested due to automatic review settings October 1, 2025 09:45
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

Copilot reviewed 6 out of 6 changed files in this pull request and generated no new comments.


Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

@gurry gurry enabled auto-merge October 1, 2025 10:53
Copy link
Collaborator

@wmmc88 wmmc88 left a comment

Choose a reason for hiding this comment

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

good improvements. agree with some of the other comments that it could be better but i think it a good incremental improvement. Also it seems like the screenshots in the pr are not up to date with the latest code here (which is also why i suggested maybe snapshotting these types of tests is a better way forward medium term)

@wmmc88 wmmc88 added the next-release-priority Issues and PRs that should be prioritized to be in the next crates.io release label Oct 2, 2025
@gurry
Copy link
Contributor

gurry commented Oct 2, 2025

it seems like the screenshots in the pr are not up to date with the latest code here

Yeah, I noticed the issues in the screenshots, especially the last one, and then fixed them in code, but was loath to update the screenshots again :D

Copy link
Contributor Author

@krishnakumar4a4 krishnakumar4a4 left a comment

Choose a reason for hiding this comment

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

These log improvements look good to me. Thanks @gurry for taking this forward.

@gurry gurry added this pull request to the merge queue Oct 6, 2025
Merged via the queue into microsoft:main with commit ca713cd Oct 6, 2025
229 checks passed
@leon-xd leon-xd mentioned this pull request Oct 17, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

next-release-priority Issues and PRs that should be prioritized to be in the next crates.io release

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants