DscResource.DocGenerator.psd1
|
@{ # 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') <# 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-preview0001] - 2020-06-20 ### 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`. ### 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. ### 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`. ' # Prerelease string of this module Prerelease = 'preview0001' } # End of PSData hashtable } # End of PrivateData hashtable } |