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.

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

CreateMarkdownHelp step in build process failing in PowerShell 7.4.0+ #71

Closed
techthoughts2 opened this issue Jan 16, 2024 · 1 comment · Fixed by #72
Closed

CreateMarkdownHelp step in build process failing in PowerShell 7.4.0+ #71

techthoughts2 opened this issue Jan 16, 2024 · 1 comment · Fixed by #72
Assignees
Labels
bug Something isn't working

Comments

@techthoughts2
Copy link
Owner

Expected Behavior

During build process CreateMarkdownHelp step should be able to successfully create markdown and external help from inline help.

Current Behavior

Checking for missing documentation in md files...
The documentation that got generated resulted in missing sections which should be filled out.
Please review the following sections in your comment based help, fill out missing information and rerun this build:
(Note: This can happen if the .EXTERNALHELP CBH is defined for a function before running this build.)    
Path of files with issues: D:\Code\Git\path\moduleName\src\Artifacts\docs\


Filename                     LineNumber Line
--------                     ---------- ----
Get-Function1.md              189 {{Fill ProgressAction Description}}
Get-Function2.md              143 {{Fill ProgressAction Description}}
Get-Function3.md              146 {{Fill ProgressAction Description}}

ERROR: Missing documentation. Please review and rebuild.
At D:\Code\Git\path\moduleName\src\moduleName.build.ps1:405 char:9
+         throw 'Missing documentation. Please review and rebuild.'
+         ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
At D:\Code\Git\path\moduleName\src\moduleName.build.ps1:349 char:1
+ Add-BuildTask CreateMarkdownHelp -After CreateHelpStart {

Generated Markdown file contains the following:

### -ProgressAction
{{Fill ProgressAction Description}}

Possible Solution

This looks to be related to a breaking change introduced in PowerShell 7.4.0.:

Added the ProgressAction parameter to the Common Parameters

Steps to Reproduce

  1. Take a sample module
  2. Initiate build with CreateMarkdownHelp option

Context (Environment)

  • Operating System and version as reported by $PSVersionTable.OS: Microsoft Windows 10.0.22000
  • PowerShell versions as reported by $PSVersionTable.PSEdition: Core
Name                           Value
----                           -----
PSVersion                      7.4.1
PSEdition                      Core
GitCommitId                    7.4.1
OS                             Microsoft Windows 10.0.22000
Platform                       Win32NT
PSCompatibleVersions           {1.0, 2.0, 3.0, 4.0…}
PSRemotingProtocolVersion      2.3
SerializationVersion           1.1.0.1
WSManStackVersion              3.0

Detailed Description

Unable to run builds that support help creation at this time.

@techthoughts2
Copy link
Owner Author

Related issue on platyPS side: PowerShell/platyPS#595

techthoughts2 added a commit that referenced this issue Jan 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant