Improve configure user experience #3158
Merged
Conversation
This file contains 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
This comment has been minimized.
This comment has been minimized.
Trenly
reviewed
Apr 16, 2023
|
|
||
| if (messageData.ShowDescription && !description.empty()) | ||
| { | ||
| constexpr size_t maximumDescriptionLines = 3; |
There was a problem hiding this comment.
Might be nice if users could configure this. Maybe just a TODO for now until we know if being able to configure would be useful
| // Required Args: ConfigurationFile | ||
| // Inputs: None | ||
| // Outputs: None | ||
| void EnsureConfigurationFileExists(Execution::Context& context); |
There was a problem hiding this comment.
This name of this almost makes me think that this could be abstracted into a generic check for files existing where an enum could provide the logic of which arg to grab the path from . winget import is one that comes to mind, install/uninstall/show with --manifest, winget hash, etc. I'm surprised this isn’t genericised already. . .
There was a problem hiding this comment.
It actually is, and I wrote it. I just didn't look hard enough to rediscover VerifyFile.
msftrubengu
approved these changes
Apr 17, 2023
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.
Change
This change improves the
configureuser experience by:configurecommand.Detailsproperty is not empty.It also logs the entire configuration file input stream to the log in verbose, and improves the progress reporting for the pre-check of the apply flow.
The initialization phases are reported as:
Validation
Only minor manual validation has been done at the time of PR creation.
Automated testing should certainly be added, but we may want to forego that at this time given how poor the current UX is and the desire to get a build out for testing.
Microsoft Reviewers: Open in CodeFlow