dsccommunity / DscResource.Common

This module contains common functions that are used in DSC resources.
https://dsccommunity.org
MIT License
9 stars 9 forks source link

DscResource.Common: Add tasks for automating documentation #113

Closed johlju closed 8 months ago

johlju commented 8 months ago

Pull Request (PR) description

This Pull Request (PR) fixes the following issues

Task list


This change is Reviewable

codecov[bot] commented 8 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Comparison is base (08436a7) 91% compared to head (7a9320a) 91%.

Additional details and impacted files [![Impacted file tree graph](https://app.codecov.io/gh/dsccommunity/DscResource.Common/pull/113/graphs/tree.svg?width=650&height=150&src=pr&token=rlTA7BkRB3&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=dsccommunity)](https://app.codecov.io/gh/dsccommunity/DscResource.Common/pull/113?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=dsccommunity) ```diff @@ Coverage Diff @@ ## main #113 +/- ## =================================== Coverage 91% 91% =================================== Files 37 37 Lines 656 656 =================================== Hits 602 602 Misses 54 54 ``` | [Files](https://app.codecov.io/gh/dsccommunity/DscResource.Common/pull/113?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=dsccommunity) | Coverage Δ | | |---|---|---| | [source/Private/Test-DscPropertyState.ps1](https://app.codecov.io/gh/dsccommunity/DscResource.Common/pull/113?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=dsccommunity#diff-c291cmNlL1ByaXZhdGUvVGVzdC1Ec2NQcm9wZXJ0eVN0YXRlLnBzMQ==) | `100% <ø> (ø)` | | | [source/Public/Assert-BoundParameter.ps1](https://app.codecov.io/gh/dsccommunity/DscResource.Common/pull/113?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=dsccommunity#diff-c291cmNlL1B1YmxpYy9Bc3NlcnQtQm91bmRQYXJhbWV0ZXIucHMx) | `100% <ø> (ø)` | | | [source/Public/Assert-ElevatedUser.ps1](https://app.codecov.io/gh/dsccommunity/DscResource.Common/pull/113?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=dsccommunity#diff-c291cmNlL1B1YmxpYy9Bc3NlcnQtRWxldmF0ZWRVc2VyLnBzMQ==) | `100% <ø> (ø)` | | | [source/Public/Assert-IPAddress.ps1](https://app.codecov.io/gh/dsccommunity/DscResource.Common/pull/113?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=dsccommunity#diff-c291cmNlL1B1YmxpYy9Bc3NlcnQtSVBBZGRyZXNzLnBzMQ==) | `100% <ø> (ø)` | | | [source/Public/Assert-Module.ps1](https://app.codecov.io/gh/dsccommunity/DscResource.Common/pull/113?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=dsccommunity#diff-c291cmNlL1B1YmxpYy9Bc3NlcnQtTW9kdWxlLnBzMQ==) | `100% <ø> (ø)` | | | [source/Public/Compare-DscParameterState.ps1](https://app.codecov.io/gh/dsccommunity/DscResource.Common/pull/113?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=dsccommunity#diff-c291cmNlL1B1YmxpYy9Db21wYXJlLURzY1BhcmFtZXRlclN0YXRlLnBzMQ==) | `80% <ø> (ø)` | | | [source/Public/Compare-ResourcePropertyState.ps1](https://app.codecov.io/gh/dsccommunity/DscResource.Common/pull/113?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=dsccommunity#diff-c291cmNlL1B1YmxpYy9Db21wYXJlLVJlc291cmNlUHJvcGVydHlTdGF0ZS5wczE=) | `100% <ø> (ø)` | | | [source/Public/ConvertFrom-DscResourceInstance.ps1](https://app.codecov.io/gh/dsccommunity/DscResource.Common/pull/113?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=dsccommunity#diff-c291cmNlL1B1YmxpYy9Db252ZXJ0RnJvbS1Ec2NSZXNvdXJjZUluc3RhbmNlLnBzMQ==) | `100% <100%> (ø)` | | | [source/Public/ConvertTo-CimInstance.ps1](https://app.codecov.io/gh/dsccommunity/DscResource.Common/pull/113?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=dsccommunity#diff-c291cmNlL1B1YmxpYy9Db252ZXJ0VG8tQ2ltSW5zdGFuY2UucHMx) | `100% <ø> (ø)` | | | [source/Public/ConvertTo-HashTable.ps1](https://app.codecov.io/gh/dsccommunity/DscResource.Common/pull/113?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=dsccommunity#diff-c291cmNlL1B1YmxpYy9Db252ZXJ0VG8tSGFzaFRhYmxlLnBzMQ==) | `100% <ø> (ø)` | | | ... and [22 more](https://app.codecov.io/gh/dsccommunity/DscResource.Common/pull/113?src=pr&el=tree-more&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=dsccommunity) | |