DscResource.DocGenerator.psd1

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

@{
    # Script module or binary module file associated with this manifest.
    RootModule        = 'DscResource.DocGenerator.psm1'

    # Version number of this module.
    ModuleVersion     = '0.6.0'

    GUID              = 'fa8b017d-8e6e-414d-9ab7-c8ab9cb9e9a4'

    # Author of this module
    Author            = 'DSC Community'

    # Company or vendor of this module
    CompanyName       = 'DSC Community'

    # Copyright statement for this module
    Copyright         = '(c) DSC Community contributors.'

    # Description of the functionality provided by this module
    Description       = 'Functionality to help generate documentation for modules.'

    # Minimum version of the Windows PowerShell engine required by this module
    PowerShellVersion = '5.0'

    <#
        Functions to export from this module, for best performance, do not use
        wildcards and do not delete the entry, use an empty array if there are
        no functions to export.
 
        This will be automatically update by the build pipeline.
    #>

    FunctionsToExport = @('New-DscResourcePowerShellHelp','New-DscResourceWikiPage','Publish-WikiContent','Set-WikiModuleVersion')

    <#
        Cmdlets to export from this module, for best performance, do not use
        wildcards and do not delete the entry, use an empty array if there are
        no cmdlets to export.
    #>

    CmdletsToExport   = @()

    # Variables to export from this module
    VariablesToExport = @()

    <#
        Aliases to export from this module, for best performance, do not use
        wildcards and do not delete the entry, use an empty array if there are
        no aliases to export.
 
        This must be set to the aliases to export since there is no way to tell
        the module builder (build pipeline) which aliases to add.
    #>

    AliasesToExport   = @(
        'Task.Generate_Conceptual_Help',
        'Task.Generate_Wiki_Content',
        'Task.Publish_GitHub_Wiki_Content'
    )

    # DSC resources to export from this module
    DscResourcesToExport = @()

    <#
        Private data to pass to the module specified in RootModule/ModuleToProcess.
        This may also contain a PSData hashtable with additional module metadata
        used by PowerShell.
    #>

    PrivateData       = @{
        PSData = @{
            # Tags applied to this module. These help with module discovery in online galleries.
            Tags         = 'DSC', 'Modules', 'documentation'

            # A URL to the license for this module.
            LicenseUri   = 'https://github.com/dsccommunity/DscResource.DocGenerator/blob/master/LICENSE'

            # A URL to the main website for this project.
            ProjectUri   = 'https://github.com/dsccommunity/DscResource.DocGenerator'

            # ReleaseNotes of this module
            ReleaseNotes = '## [0.6.0] - 2020-06-22
 
### Added
 
- Added cmdlet `Publish-WikiContent` that publishes the Wiki content
  generated by the cmdlet `New-DscResourceWikiPage`.
- Added build task `Publish_GitHub_Wiki_Content` that can publish content
  to a GitHub Wiki repository. This task runs the cmdlet `Publish-WikiContent`.
- Added a markdown page `Home.md` to the folder `source/WikiSource` that
  will be published to the GitHub Wiki for each PR that is merged. The
  module version number will be updated prior to pushing to the Wiki.
  This is done by the the build task `Publish_GitHub_Wiki_Content`.
 
### Removed
 
- The parameter `WikiSourcePath` was removed from the function `Copy-WikiFolder`.
- The parameter `WikiSourcePath` was removed from the function `Publish-WikiContent`.
- The parameter `WikiSourceFolderName` was removed from the build task
  `Publish_GitHub_Wiki_Content`.
- The function `Publish-WikiContent` will no longer call the function
  `Set-WikiModuleVersion` (it is now done by the task `Generate_Wiki_Content`).
 
### Changed
 
- Update the documentation style in the README.md.
- The repository is using the latest version of the module ModuleBuilder.
- The repository was pinned to use version 4.10.1 of the module Pester
  since this repository does not support Pester 5 tests yet.
- Updated `build.ps1` to be able to dogfood build tasks.
- Moved the Wiki source logic from `Publish-WikiContent` to the build task
  `Generate_Wiki_Content` to align with the other tasks that creates a
  build artifact that should be deployed. `Publish-WikiContent` no longer
  changes the build artifact during publishing. The build task
  `Generate_Wiki_Content` now first generates documentation for any existing
  DSC resources. Secondly if the Wiki source folder (defaults to `WikiSource`)
  exists in the source folder then the content of that folder will be copied
  to the Wiki output folder (defaults to `output/WikiOutput`). If there is a
  markdown file called `Home.md` then any module version placeholders (`#.#.#`)
  will be replaced by the built module version.
- The `Set-WikiModuleVersion` was made a public function to be able to
  use it in the build task `Generate_Wiki_Content`.
 
### Fixed
 
- Fixed issue with `New-DscResourceWikiPage` where Test-Path was case sensitive
  on Linux machines and therefore didn''t find some Readme.md files.
- Minor style and documentation updates to the build tasks `Generate_Wiki_Content`
  and `Generate_Conceptual_Help`.
- Fixed example in comment-based help form cmdlet `New-DscResourceWikiPage`.
- Fixed a problem in the build task `Publish_GitHub_Wiki_Content` that
  made the Wiki output path to not shown correctly.
 
'


            # Prerelease string of this module
            Prerelease = ''
        } # End of PSData hashtable
    } # End of PrivateData hashtable
}