gaelcolas / Sampler

Module template with build pipeline and examples, including DSC elements.

MIT License

167 stars 42 forks source link

Automatic wiki documentation #471

Closed johlju closed 1 month ago

johlju commented 4 months ago

Pull Request

Pull Request (PR) description

Added

Automatic wiki documentation for public commands.
Changed
Public command documentation has been moved from README.md to the GitHub repository Wiki.
Update order of deploy tasks for the Plaster templates to make it easier to re-run a deploy phase when a GitHub token has expired.

Task list

[x] The PR represents a single logical change. i.e. Cosmetic updates should go in different PRs.
[x] Added an entry under the Unreleased section of in the CHANGELOG.md as per format.
[x] Local clean build passes without issue or fail tests (build.ps1 -ResolveDependency).
[x] Documentation added/updated in README.md.
[ ] Comment-based help added/updated.
[ ] Localization strings added/updated in all localization files as appropriate.
[ ] Unit tests added/updated. See DSC Community Testing Guidelines.
[ ] Integration tests added/updated (where possible). See DSC Community Testing Guidelines.
[x] New/changed code adheres to DSC Community Style Guidelines.

This change is

johlju commented 4 months ago

I think we must resolve the issue https://github.com/dsccommunity/DscResource.DocGenerator/issues/135 before merging this so this can be more precise in the task that needs to be run. Otherwise it will fail to generate docs on Linux or macOS because it defaults to generate docs for DSC resource which this module probably never will have. It is not currently possible to exclude that without loosing other functionality.

codecov[bot] commented 4 months ago

Codecov Report

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

Project coverage is 81%. Comparing base (77d44e1) to head (5245c66). Report is 5 commits behind head on main.

Additional details and impacted files

[![Impacted file tree graph](https://app.codecov.io/gh/gaelcolas/Sampler/pull/471/graphs/tree.svg?width=650&height=150&src=pr&token=xHbQB1FHYN&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Gael)](https://app.codecov.io/gh/gaelcolas/Sampler/pull/471?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Gael) ```diff @@ Coverage Diff @@ ## main #471 +/- ## =================================== Coverage 81% 81% =================================== Files 44 44 Lines 2328 2328 =================================== Hits 1904 1904 Misses 424 424 ```