dsccommunity / ActiveDirectoryDsc

This module contains DSC resources for deployment and configuration of Active Directory Domain Services.
MIT License
335 stars 140 forks source link

Build process missing 'Get-MarkdownMetadata' cmdlet #714

Open Borgquite opened 1 month ago

Borgquite commented 1 month ago

The build process is currently working, but during a build I happened to notice a repeating error under the 'Build & Package Module' section:

https://dev.azure.com/dsccommunity/ActiveDirectoryDsc/_build/results?buildId=9099&view=logs&j=bce26a94-9049-50eb-6c1c-385ccbec51f9&t=512e4b73-7a3e-57af-0534-ae809c1351da

pwsh.exe : The term 'Get-MarkdownMetadata' is not recognized as a name of a cmdlet, function, script file, or executable program.
Check the spelling of the name, or if a path was included, verify that the path is correct and try again.
At D:\a\1\s\output\RequiredModules\DscResource.DocGenerator\0.12.4\DscResource.DocGenerator.psm1:3283 char:29
+ … nMetadata = & $pwshPath -Command $getMarkdownMetadataScriptBlock -Exe …
+               ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+ CategoryInfo          : ObjectNotFound: (Get-MarkdownMetadata:String) [], CommandNotFoundException
+ FullyQualifiedErrorId : CommandNotFoundException

And at the end, some warnings:

WARNING: /Generate_Markdown_For_Public_Commands D:\a\1\s\output\RequiredModules\DscResource.DocGenerator\0.12.4\tasks\Generate_Markdown_For_Public_Commands.build.ps1:126
PlatyPS is not installed. Skipping. If public command documentation should be created please make sure PlatyPS is available in a path that is listed in $PSModulePath. It can be added to the configuration file RequiredModules.psd1 in the project.
WARNING: /Generate_External_Help_File_For_Public_Commands D:\a\1\s\output\RequiredModules\DscResource.DocGenerator\0.12.4\tasks\Generate_External_Help_File_For_Public_Commands.build.ps1:87
PlatyPS is not installed. Skipping. If public command documentation should be created please make sure PlatyPS is available in a path that is listed in $PSModulePath. It can be added to the configuration file RequiredModules.psd1 in the project.

Is this an issue?

johlju commented 1 month ago

The newest version of the tasks require PlatyPS. Maybe we can add it as here? https://github.com/gaelcolas/Sampler/blob/e669ffae8f8cdf07a4e3e2f0361c078aa74d1eff/RequiredModules.psd1#L26 Otherwise we have to pin an older version of DscResource.DocGenerator to get back the old behavior.

I wonder if DscResource.DocGenerator module so add a dependency on PlatyPS. 🤔