Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Build process missing 'Get-MarkdownMetadata' cmdlet #714

Open
Borgquite opened this issue Jul 29, 2024 · 1 comment · May be fixed by #715
Open

Build process missing 'Get-MarkdownMetadata' cmdlet #714

Borgquite opened this issue Jul 29, 2024 · 1 comment · May be fixed by #715
Labels
enhancement The issue is an enhancement request. help wanted The issue is up for grabs for anyone in the community.

Comments

@Borgquite
Copy link
Contributor

Borgquite commented Jul 29, 2024 •
edited
Loading

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
Copy link
Member

johlju commented Jul 29, 2024

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. 🤔

@johlju johlju added enhancement The issue is an enhancement request. help wanted The issue is up for grabs for anyone in the community. labels Jul 29, 2024
@Borgquite Borgquite linked a pull request Jul 30, 2024 that will close this issue
Open
9 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement The issue is an enhancement request. help wanted The issue is up for grabs for anyone in the community.
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Add PlatyPS to required modules Borgquite/ActiveDirectoryDsc
2 participants
@johlju @Borgquite