tasks/Publish_GitHub_Wiki_Content.build.ps1

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
<#
    .SYNOPSIS
        This is a build task that generates conceptual help.
 
    .PARAMETER ProjectPath
        The root path to the project. Defaults to $BuildRoot.
 
    .PARAMETER OutputDirectory
        The base directory of all output. Defaults to folder 'output' relative to
        the $BuildRoot.
 
    .PARAMETER BuiltModuleSubdirectory
        Sub folder where you want to build the Module to (instead of $OutputDirectory/$ModuleName).
        This is especially useful when you want to build DSC Resources, but you don't want the
        `Get-DscResource` command to find several instances of the same DSC Resources because
        of the overlapping $Env:PSmodulePath (`$buildRoot/output` for the built module and `$buildRoot/output/RequiredModules`).
 
        In most cases I would recommend against setting $BuiltModuleSubdirectory.
 
    .PARAMETER VersionedOutputDirectory
        Whether the Module is built with its versioned Subdirectory, as you would see it on a System.
        For instance, if VersionedOutputDirectory is $true, the built module's ModuleBase would be: `output/MyModuleName/2.0.1/`
 
    .PARAMETER ProjectName
        The project name. Defaults to the BaseName of the module manifest it finds
        in either the folder 'source', 'src, or a folder with the same name as
        the module.
 
    .PARAMETER SourcePath
        The path to the source folder name. Defaults to the same path where the
        module manifest is found.
 
    .PARAMETER WikiContentFolderName
        The name of the folder that contain the content to publish to the wiki.
        The name should be relative to the OutputDirectory. Defaults to 'WikiContent'.
 
    .PARAMETER GitHubToken
        The token to use to push a commit and tag to the wiki repository. Defaults
        to an empty string.
 
    .PARAMETER GitHubConfigUserEmail
        The e-mail address to use for the commit. Defaults to an empty string.
 
    .PARAMETER GitHubConfigUserName
        The username to use for the commit. Defaults to an empty string.
 
    .PARAMETER BuildInfo
        The build info object from ModuleBuilder. Defaults to an empty hashtable.
 
    .NOTES
        This is a build task that is primarily meant to be run by Invoke-Build but
        wrapped by the Sampler project's build.ps1 (https://github.com/gaelcolas/Sampler).
#>

param
(
    [Parameter()]
    [System.String]
    $ProjectPath = (property ProjectPath $BuildRoot),

    [Parameter()]
    [System.String]
    $OutputDirectory = (property OutputDirectory (Join-Path $BuildRoot 'output')),

    [Parameter()]
    [System.String]
    $BuiltModuleSubdirectory = (property BuiltModuleSubdirectory ''),

    [Parameter()]
    [System.Management.Automation.SwitchParameter]
    $VersionedOutputDirectory = (property VersionedOutputDirectory $true),

    [Parameter()]
    [System.String]
    $ProjectName = (property ProjectName $(Get-SamplerProjectName -BuildRoot $BuildRoot)),

    [Parameter()]
    [System.String]
    $SourcePath = (property SourcePath $(Get-SamplerSourcePath -BuildRoot $BuildRoot)),

    [Parameter()]
    [System.String]
    $WikiContentFolderName = (property WikiContentFolderName 'WikiContent'),

    [Parameter()]
    [System.String]
    $GitHubToken = (property GitHubToken ''),

    [Parameter()]
    [System.String]
    $GitHubConfigUserEmail = (property GitHubConfigUserEmail ''),

    [Parameter()]
    [System.String]
    $GitHubConfigUserName = (property GitHubConfigUserName ''),

    [Parameter()]
    [System.Collections.Hashtable]
    $BuildInfo = (property BuildInfo @{ })
)

# Synopsis: This task publishes documentation to a GitHub Wiki repository.
task Publish_GitHub_Wiki_Content {
    if ([System.String]::IsNullOrEmpty($GitHubToken))
    {
        Write-Build Yellow 'Skipping task. Variable $GitHubToken not set via parent scope, as an environment variable, or passed to the build task.'
    }
    else
    {
        $debugTask = $BuildInfo.'DscResource.DocGenerator'.Publish_GitHub_Wiki_Content.Debug

        # Only show debug information if Debug was set to 'true' in build configuration.
        if ($debugTask)
        {
            "Running task with debug information."

            $local:VerbosePreference = 'Continue'
            $local:DebugPreference = 'Continue'
        }

        $OutputDirectory = Get-SamplerAbsolutePath -Path $OutputDirectory -RelativeTo $BuildRoot

        "`tOutputDirectory = '$OutputDirectory'"

        $BuiltModuleSubdirectory = Get-SamplerAbsolutePath -Path $BuiltModuleSubdirectory -RelativeTo $OutputDirectory

        if ($VersionedOutputDirectory)
        {
            <#
                VersionedOutputDirectory is not [bool]'' nor $false nor [bool]$null
                Assume true, wherever it was set
            #>

            $VersionedOutputDirectory = $true
        }
        else
        {
            <#
                VersionedOutputDirectory may be [bool]'' but we can't tell where it's
                coming from, so assume the build info (Build.yaml) is right
            #>

            $VersionedOutputDirectory = $BuildInfo['VersionedOutputDirectory']
        }

        $GetBuiltModuleManifestParams = @{
            OutputDirectory          = $OutputDirectory
            BuiltModuleSubdirectory  = $BuiltModuleSubDirectory
            ModuleName               = $ProjectName
            VersionedOutputDirectory = $VersionedOutputDirectory
            ErrorAction              = 'Stop'
        }

        $builtModuleManifest = Get-SamplerBuiltModuleManifest @GetBuiltModuleManifestParams
        $builtModuleManifest = [string](Get-Item -Path $builtModuleManifest).FullName

        "`tBuilt Module Manifest = '$builtModuleManifest'"

        $builtModuleBase = Get-SamplerBuiltModuleBase @GetBuiltModuleManifestParams
        $builtModuleBase = [string](Get-Item -Path $builtModuleBase).FullName

        "`tBuilt Module Base = '$builtModuleBase'"

        $moduleVersion = Get-BuiltModuleVersion @GetBuiltModuleManifestParams
        $moduleVersionObject = Split-ModuleVersion -ModuleVersion $moduleVersion
        $moduleVersionFolder = $moduleVersionObject.Version
        $preReleaseTag = $moduleVersionObject.PreReleaseString

        "`tModule Version = '$ModuleVersion'"
        "`tModule Version Folder = '$moduleVersionFolder'"
        "`tPre-release Tag = '$preReleaseTag'"

        "`tProject Path = $ProjectPath"
        "`tProject Name = $ProjectName"
        "`tSource Path = $SourcePath"
        "`tBuilt Module Base = $builtModuleBase"

        # If variables are not set then update variables from the property values in the build.yaml.
        foreach ($gitHubConfigKey in @('GitHubConfigUserName', 'GitHubConfigUserEmail'))
        {
            if (-not (Get-Variable -Name $gitHubConfigKey -ValueOnly -ErrorAction 'SilentlyContinue'))
            {
                # Variable is not set in context, use $BuildInfo.GitHubConfig.<varName>
                $gitHubConfigKeyValue = $BuildInfo.GitHubConfig.($gitHubConfigKey)

                Set-Variable -Name $gitHubConfigKey -Value $gitHubConfigKeyValue
                Write-Build DarkGray "Set $gitHubConfigKey to $gitHubConfigKeyValue"
            }
        }

        $invokeGitParameters = @{
            WorkingDirectory = $ProjectPath
            Arguments        = @('remote', 'get-url', 'origin')
            PassThru         = $true
        }

        if ($debugTask)
        {
            $invokeGitParameters.Verbose = $true
            $invokeGitParameters.Debug = $true
        }

        $gitRemoteResult = Invoke-Git @invokeGitParameters

        if ($gitRemoteResult.ExitCode -eq 0)
        {
            $remoteURL = $gitRemoteResult.StandardOutput -replace '\r?\n'
        }

        # Parse the URL for owner name and repository name.
        if ($remoteURL -match 'github')
        {
            $GHRepo = Get-GHOwnerRepoFromRemoteUrl -RemoteUrl $remoteURL
        }
        else
        {
            throw "Could not parse owner and repository from the git remote origin URL: '$remoteUrl'."
        }

        $wikiOutputPath = Join-Path -Path $OutputDirectory -ChildPath $WikiContentFolderName

        "`tWiki Output Path = $wikiOutputPath"

        $publishWikiContentParameters = @{
            Path              = $wikiOutputPath
            OwnerName         = $GHRepo.Owner
            RepositoryName    = $GHRepo.Repository
            ModuleName        = $ProjectName
            ModuleVersion     = $moduleVersion
            GitHubAccessToken = $GitHubToken
            GitUserEmail      = $GitHubConfigUserEmail
            GitUserName       = $GitHubConfigUserName
        }

        if ($debugTask)
        {
            $publishWikiContentParameters.Verbose = $true
            $publishWikiContentParameters.Debug = $true
        }

        Write-Build Magenta "Publishing Wiki content."

        Publish-WikiContent @publishWikiContentParameters
    }
}