dsccommunity / DscResource.DocGenerator

Module for generation of DSC resource documentation
MIT License
9 stars 10 forks source link

`Generate_Markdown_For_DSC_Resources`: Cannot find the metadata configuration #161

Closed johlju closed 1 month ago

johlju commented 1 month ago

Details of the scenario you tried and the problem that is occurring

When the tasks was renamed in a priori PR the build configuration key for metadata was also change resulting in the metatdata is no longer read from the build configuration.

https://github.com/dsccommunity/DscResource.DocGenerator/blob/66b21b92bbbff46df99cec750ef889412087d5d4/source/tasks/Generate_Markdown_For_DSC_Resources.build.ps1#L92

Steps to reproduce the problem

Run the task in a module that uses the old configuration key.

Expected behavior

Should get correct metadata information and output a warning.

Current behavior

Task does no get the configure metadata resulting in a wrong expected behavior

Suggested solution to the issue

If the new configuration key does not exist, check if the old configuration key exist. If it does output a warning message saying to modify the configuration and then keep using the old configuration key.

The operating system the target node is running

n/a

Version and build of PowerShell the target node is running

n/a

Version of the module that was used

0.13.0-preview0001