dsccommunity / DscResource.DocGenerator

Module for generation of DSC resource documentation

MIT License

9 stars 10 forks source link

Handle existing sidebar file during publish #106

Closed johlju closed 2 years ago

johlju commented 2 years ago

Pull Request

Pull Request (PR) description

When there is an existing _Sidebar.md in the folder 'WikiSource' that is copied to the folder 'WikiContent', it will no longer be overwritten during publish (issue #105).

This Pull Request (PR) fixes the following issues

Fixes #105

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).
[x] Documentation added/updated in README.md.
[ ] Comment-based help added/updated.
[ ] Localization strings added/updated in all localization files as appropriate.
[ ] Examples appropriately added/updated.
[x] Unit tests added/updated.
[ ] Integration tests added/updated (where possible).
[x] New/changed code adheres to DSC Community Style Guidelines.

This change is

codecov[bot] commented 2 years ago

Codecov Report

Merging #106 (c468b99) into main (e2e8e62) will decrease coverage by 0%. The diff coverage is 100%.

@@         Coverage Diff         @@
##           main   #106   +/-   ##
===================================
- Coverage    98%    97%   -1%     
===================================
  Files        42     42           
  Lines       959    960    +1     
===================================
- Hits        941    940    -1     
- Misses       18     20    +2

Impacted Files	Coverage Δ
source/Private/New-WikiSidebar.ps1	`100% <100%> (ø)`
source/tasks/Publish_GitHub_Wiki_Content.build.ps1	`96% <0%> (-3%)`	:arrow_down:

ykuijs commented 2 years ago

Don't think the new behavior of the function in this PR is the desired behavior: What if you release a new version, which generates a sidebar. Then with the next release, you want the sidebar to be updated, for example because new resources has been added for which documentation has been generated that should be added to the sidebar as well. But since the WikiSource already contains the previously generated sidebar, with this change a new sidebar will never be updated after it was generated once.

I think the toggle I suggested in the issue would make more sense. Then the repo owner can specify if he wants the sidebar to be generated or not.

johlju commented 2 years ago

The comment @ykuijs made was a misunderstanding that was cleared out in the discussion in the issue #105.

johlju commented 2 years ago

@PlagueHO ready for review again. 🙂