Fix default logPath when no user profile is available#283
Merged
HowardWolosky merged 4 commits intomicrosoft:masterfrom Sep 9, 2020
Merged
Fix default logPath when no user profile is available#283HowardWolosky merged 4 commits intomicrosoft:masterfrom
HowardWolosky merged 4 commits intomicrosoft:masterfrom
Conversation
Contributor
Author
|
/azp run PowerShellForGitHub-CI |
|
Azure Pipelines successfully started running 1 pipeline(s). |
In Azure Function Apps, the special `MyDocuments` folder resolves to an empty string, which means that the default `logPath` gets stored as an empty string. This causes problems when `Write-Log` attempts to write anything out. In this scenario, we'll fall back to using the temp folder and writing a warning out to the user letting them know this has happened. Resolves microsoft#282
4cdf479 to
e4e3127
Compare
Contributor
Author
|
/azp run PowerShellForGitHub-CI |
|
Azure Pipelines successfully started running 1 pipeline(s). |
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.
Description
In Azure Function Apps, the special
MyDocumentsfolder resolves to an empty string, which means that the defaultlogPathgets stored as an empty string.PowerShellForGitHub/GitHubConfiguration.ps1
Lines 650 to 657 in 3094c97
PowerShellForGitHub/GitHubConfiguration.ps1
Line 671 in 3094c97
This causes problems when
Write-Logis called by any other function, because we directly assign the current configuration value forLogPathas the parameter's default, which throws an exception when an empty string is assigned.PowerShellForGitHub/Helpers.ps1
Line 142 in 3094c97
In this scenario, we'll fall back to using the
LocalApplicationDataFolderfolder and writing a warning out to the user letting them know this has happened.Documentation has also been updated to reflect this behavior change.
Issues Fixed
Resolves #282
References
n/a
Checklist
Comment-based help added/updated, including examples.Formatters were created for any new types being added.New/changed code continues to support the pipeline.Unit tests were added/updated and are all passing. See testing guidelines. This includes making sure that all pipeline input variations have been covered.Relevant usage examples have been added/updated in USAGE.md.If desired, ensure your name is added to our Contributors list