dsccommunity / DscResource.DocGenerator

Module for generation of DSC resource documentation

MIT License

9 stars 10 forks source link

Add `Show-InvokeGitReturn`: fixes Issue #90 #96

Closed phbits closed 3 years ago

phbits commented 3 years ago

Pull Request

Pull Request (PR) description

Adds function Show-InvokeGitReturn to improve error handling when using Invoke-Git.

This Pull Request (PR) fixes the following issues

Fixes #90

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.
[x] 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

phbits commented 3 years ago

@johlju - Here's my fix to add better error handling around Invoke-Git. It successfully goes through build and test; however, I need to test in Azure Pipelines and somehow test publishing. 🤔 Even though there's still work to do, I wanted to open a PR to see if you have any feedback. In fact, as I'm typing this some of the checks are already finished as failed. 👷‍♂️

johlju commented 3 years ago

Thanks for this PR! This is my initial review looking through it, I found some things, but will look deeper into it once these comments are resolved. 🙂

codecov[bot] commented 3 years ago

Codecov Report

Merging #96 (9d04c7e) into main (5be73af) will increase coverage by 0%. The diff coverage is 100%.

@@        Coverage Diff         @@
##           main   #96   +/-   ##
==================================
  Coverage    98%   98%           
==================================
  Files        40    42    +2     
  Lines       949   955    +6     
==================================
+ Hits        931   937    +6     
  Misses       18    18

johlju commented 3 years ago

Please update (rebase) working branch with latest changes from main branch.

phbits commented 3 years ago

@johlju Just finished testing the module by forklifting it into phbits/MyModule. Wiki publishing worked as expected. 🥳

johlju commented 3 years ago

Awesome work on this one! 😄