Make Generate_Wiki_Content a metatask that runs other build tasks

[johlju]

Suggest making Generate_Wiki_Content a metatask and the current Generate_Wiki_Content is renamed to Generate_Markdown_For_DSC_Resources (or something similar).

The new metatask Generate_Wiki_Content will run all the tasks that is needed to generate the wiki content:

• Generate_Markdown_For_DSC_Resources
• Generate_Markdown_For_Public_Commands
• Generate_External_Help_File_For_Public_Commands
• Clean_Markdown_Of_Public_Commands

[johlju]

There is an issue excluding certain part of the documentation being generated. To simplify that I suggest we should also have:

• New tasks Create_Wiki_Output_Folder for the code:

DscResource.DocGenerator/source/tasks/Generate_Wiki_Content.build.ps1

Lines 88 to 95 in bb39323

	$wikiOutputPath = Join-Path -Path $OutputDirectory -ChildPath 'WikiContent'
	if ((Test-Path -Path $wikiOutputPath) -eq $false)
	{
	$null = New-Item -Path $wikiOutputPath -ItemType Directory
	}
	"`tWiki Output Path = $wikiOutputPath"

• New task Copy_Source_Wiki_Folder for the code:

DscResource.DocGenerator/source/tasks/Generate_Wiki_Content.build.ps1

Lines 97 to 104 in bb39323

	$wikiSourcePath = Join-Path -Path $SourcePath -ChildPath $WikiSourceFolderName
	$wikiSourceExist = Test-Path -Path $wikiSourcePath
	if ($wikiSourceExist)
	{
	"`tWiki Source Path = $wikiSourcePath"
	}

DscResource.DocGenerator/source/tasks/Generate_Wiki_Content.build.ps1

Lines 112 to 126 in bb39323

	if ($wikiSourceExist)
	{
	Write-Build -Color 'Magenta' -Text 'Copying Wiki content from the Wiki source folder.'
	Copy-Item -Path (Join-Path $wikiSourcePath -ChildPath '*') -Destination $wikiOutputPath -Recurse -Force
	$homeMarkdownFilePath = Join-Path -Path $wikiOutputPath -ChildPath 'Home.md'
	if (Test-Path -Path $homeMarkdownFilePath)
	{
	Write-Build -Color 'Magenta' -Text 'Updating module version in Home.md if there are any placeholders found.'
	Set-WikiModuleVersion -Path $homeMarkdownFilePath -ModuleVersion $moduleVersion
	}
	}

• The following code goes into the (above) suggested Generate_Markdown_For_DSC_Resources:

DscResource.DocGenerator/source/tasks/Generate_Wiki_Content.build.ps1

Lines 106 to 110 in bb39323

	Write-Build -Color 'Magenta' -Text 'Generating Wiki content for all DSC resources based on source and built module.'
	$dscResourceMarkdownMetadata = $BuildInfo.'DscResource.DocGenerator'.Generate_Wiki_Content
	New-DscResourceWikiPage -SourcePath $SourcePath -BuiltModulePath $builtModuleBase -OutputPath $wikiOutputPath -Metadata $dscResourceMarkdownMetadata -Force

[dan-hughes]

@johlju, do you have an example of this. Looks to be a good one to release at the same time as the other task addition.

[johlju]

A meta task is made the same way as other task, it just references other tasks instead of having code by itself

Task Generate_Wiki_Content Create_Wiki_Output_Folder, Copy_Source_Wiki_Folder, Generate_Markdown_For_DSC_Resources, Generate_Markdown_For_Public_Commands, Generate_External_Help_File_For_Public_Commands, Clean_Markdown_Of_Public_Commands

Happy to review this if you have the time.

[dan-hughes]

Let me draft something and see if I understand it.

[johlju]

There is a bit of work splitting up the existing task into seperate tasks. But would be great to get it in, then I can complete a PR in Sampler that waits for this issue. 🙂

[dan-hughes]

Params - are these the same for each of the tasks?
Also how can I pass variables between tasks?

[johlju]

Yes I would say so, unless one is not specifically used I guess it can be skipped 🤔
But easiest is just copy all params to all tasks.