dsccommunity / DscResource.DocGenerator

Module for generation of DSC resource documentation

MIT License

9 stars 10 forks source link

fixes #84 & removes --quiet #87

Closed phbits closed 3 years ago

phbits commented 3 years ago

Pull Request

Pull Request (PR) description

Sets Invoke-Git -TimeOut to milliseconds.
Removes --quiet switch from git commands
Fixes tests

This Pull Request (PR) fixes the following issues

Fixes #84

Task list

[x] Added an entry to the change log under the Unreleased section of the file CHANGELOG.md. Entry should say what was changed and how that affects users (if applicable), and reference the issue being resolved (if applicable).
[ ] Documentation added/updated in README.md.
[x] Comment-based help added/updated.
[ ] Localization strings added/updated in all localization files as appropriate.
[x] Examples appropriately added/updated.
[x] Unit tests added/updated.
[x] Integration tests added/updated (where possible).
[x] New/changed code adheres to DSC Community Style Guidelines.

This change is

codecov[bot] commented 3 years ago

Codecov Report

Merging #87 (57fb81c) into main (c75f492) will not change coverage. The diff coverage is 100%.

@@        Coverage Diff         @@
##           main   #87   +/-   ##
==================================
  Coverage    97%   97%           
==================================
  Files        38    38           
  Lines       877   877           
==================================
  Hits        859   859           
  Misses       18    18

phbits commented 3 years ago

@johlju Thanks for setting up the debug branch! I'll take a closer look in the next day or two. As you'll notice, the issue was $TimeOut needed to be specified in milliseconds. 🤦‍♂️ Also removed all --quiet switches from the git commands allowing the Invoke-Git returned object to be populated. Finally, in the last commit, the more specific Assert wasn't being triggered which didn't make much sense. I made the "fix" so this PR could be posted and fix publishing. I can take a closer look later if you'd like to go back to the prior technique of having two separate Assert statements. Again, wanted to get this posted. Hope that makes sense.

johlju commented 3 years ago

Thanks for taking the time to send in fixes! 🙂 I will review this as soon as I have time (hopefully tomorrow).

phbits commented 3 years ago

Sounds good.

Did some testing locally and found $Arguments[2] -eq "*" would work as expected; calling each Assert once. Updated it to $Arguments[2] -eq $($mockPublishWikiContentParameters.ModuleVersion)", just like 17b3cf6, and it completed successfully too. Pushed commit with enthusiasm... and Azure Pipelines doesn't like it. 🤔