HelpVersion is module metadata used to create HelpInfo.xml files for updateable help. Cmdlets that export module markdown files should support a HelpVersion parameter that allows the user to specify the version of help.
New-MarkdownCommandHelp (when using -WithModulePage)
Export-MarkdownModuleFile
Update-MarkdownCommandHelp (when using -WithModulePage)
Behaviors
The type for the HelpVersion parameter should be System.Version and should accept strings that can be converted to that type.
The default value of the HelpVersion parameter should be [System.Version]'1.0.0.0'. This is the value that should be used when no value is provided or if it is missing from an imported module markdown file.
This value should be written to the module markdown file frontmatter metadata in the Help Version: key. For example Help Version: 1.0.0.0.
It is up to the author to change the value in the frontmatter as appropriate.
The value of the HelpVersion parameter should take precendence over an existing value imported from markdown or a duplicate value that was passed in using the Metadata parameter hashtable.
sdwheeler
commented
2 days ago
Summary of the new feature / enhancement
HelpVersion is module metadata used to create HelpInfo.xml files for updateable help. Cmdlets that export module markdown files should support a HelpVersion parameter that allows the user to specify the version of help.
Proposed technical implementation details (optional)
Cmdlets that need to support this:
Behaviors
System.Versionand should accept strings that can be converted to that type.[System.Version]'1.0.0.0'. This is the value that should be used when no value is provided or if it is missing from an imported module markdown file.Help Version:key. For exampleHelp Version: 1.0.0.0.