Update pipeline files (#119)

.gitattributes

@@ -1,8 +1,17 @@
 # Needed for publishing of examples, build worker defaults to core.autocrlf=input.
+# The Sampler pipeline template suggest using '* text eol=autocrlf' but that will
+# make some tests fail with CR/LF differences.
 * text eol=crlf
 
+*.mof   text eol=crlf
+*.sh    text eol=lf
+*.svg   eol=lf
+
 # Ensure any exe files are treated as binary
 *.exe binary
 *.jpg binary
 *.xl* binary
 *.pfx binary
+*.png binary
+*.dll binary
+*.so  binary

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,6 @@
+blank_issues_enabled: false
+contact_links:
+  - name: "Virtual PowerShell User Group #DSC channel"
+    url: https://dsccommunity.org/community/contact/
+    about: "To talk to the community and maintainers of DSC Community, please visit the #DSC channel."
+

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,50 +1,49 @@
-# Pull Request
 <!--
-    Thanks for submitting a Pull Request (PR) to this project.
-    Your contribution to this project is greatly appreciated!
-    
-    If this is a breaking change then prefix the PR title
-    with 'BREAKING CHANGE:',
+    Thanks for submitting a Pull Request (PR) to this project. Your contribution to this project
+    is greatly appreciated!
+
+    If this is a breaking change, then also prefix the PR title with 'BREAKING CHANGE:',
     e.g. 'BREAKING CHANGE: My short description'.
 
-    You may remove this comment block, and the other comment blocks, but please 
-    keep the headers and the task list.
+    You may remove this comment block, and the other comment blocks, but please keep the headers
+    and the task list.
 -->
-### Pull Request (PR) description
+
+#### Pull Request (PR) description
+
 <!--
-    Replace this comment block with a description of your PR.
-    Also, make sure you have updated the CHANGELOG.md, see the
-    task list below. An entry in the CHANGELOG.md is mandatory
-    for all PRs.
+    Replace this comment block with a description of your PR. Also, make sure you have updated the
+    CHANGELOG.md, see the task list below. An entry in the CHANGELOG.md is mandatory for all PRs.
 -->
 
 #### This Pull Request (PR) fixes the following issues
+
 <!--
-    If this PR does not fix an open issue, replace this comment block with None.
-    If this PR resolves one or more open issues, replace this comment block with
-    a list of the issues using a GitHub closing keyword, e.g.:
+    If this PR does not fix an open issue, replace this comment block with None. If this PR
+    resolves one or more open issues, replace this comment block with a list of the issues using
+    a GitHub closing keyword, e.g.:
 
 - Fixes #123
 - Fixes #124
 -->
 
 #### Task list
+
 <!--
-    To aid community reviewers in reviewing and merging your PR, please take
-    the time to run through the below checklist and make sure your PR has
-    everything updated as required.
+    To aid community reviewers in reviewing and merging your PR, please take the time to run
+    through the below checklist and make sure your PR has everything updated as required.
 
-    Change to [x] for each task in the task list that applies to your PR.
-    For those task that don't apply to you PR, leave those as is.
+    Change to [x] for each task in the task list that applies to your PR. For those task that
+    don't apply to you PR, leave those as is.
 -->
-- [ ] Added an entry to the change log under the Unreleased section of the
-      file CHANGELOG.md. Entry should say what was changed and how that
-      affects users (if applicable), and reference the issue being resolved
-      (if applicable).
+
+- [ ] Added an entry to the change log under the Unreleased section of the file CHANGELOG.md.
+      Entry should say what was changed and how that affects users (if applicable), and
+      reference the issue being resolved (if applicable).
 - [ ] Documentation added/updated in README.md.
 - [ ] Comment-based help added/updated.
 - [ ] Localization strings added/updated in all localization files as appropriate.
 - [ ] Examples appropriately added/updated.
-- [ ] Unit tests added/updated.
-- [ ] Integration tests added/updated (where possible).
+- [ ] Unit tests added/updated. See [DSC Community Testing Guidelines](https://dsccommunity.org/guidelines/testing-guidelines).
+- [ ] Integration tests added/updated (where possible). See [DSC Community Testing Guidelines](https://dsccommunity.org/guidelines/testing-guidelines).
 - [ ] New/changed code adheres to [DSC Community Style Guidelines](https://dsccommunity.org/styleguidelines).

.gitignore

@@ -5,6 +5,7 @@ output/
 !**/README.md
 .kitchen/
 
+*.nupkg
 *.suo
 *.user
 *.coverage

.vscode/settings.json

@@ -10,10 +10,12 @@
     "powershell.codeFormatting.pipelineIndentationStyle": "IncreaseIndentationAfterEveryPipeline",
     "powershell.codeFormatting.preset": "Custom",
     "powershell.codeFormatting.alignPropertyValuePairs": true,
-    "files.trimTrailingWhitespace": true,
-    "files.insertFinalNewline": true,
+    "powershell.developer.bundledModulesPath": "${cwd}/output/RequiredModules",
     "powershell.scriptAnalysis.settingsPath": ".vscode\\analyzersettings.psd1",
     "powershell.scriptAnalysis.enable": true,
+    "files.trimTrailingWhitespace": true,
+    "files.trimFinalNewlines": true,
+    "files.insertFinalNewline": true,
     "files.associations": {
         "*.ps1xml": "xml"
     },

.vscode/tasks.json

@@ -41,7 +41,7 @@
             "label": "build",
             "type": "shell",
             "command": "&${cwd}/build.ps1",
-            "args": ["-AutoRestore"],
+            "args": [],
             "presentation": {
                 "echo": true,
                 "reveal": "always",

CHANGELOG.md

@@ -1,10 +1,17 @@
-# Change log for DscResource.DocGenerator
+# Changelog for DscResource.DocGenerator
 
 The format is based on and uses the types of changes according to [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
 
+### Changed
+
+- Updated pipelines files to the latest in Sampler.
+- Fix missing verbose message in function `Invoke-Git`.
+- Fix variable reference for localized strings so they passed HQRM tests.
+- Fix statement so function passed HQRM tests.
+
 ## [0.10.3] - 2022-01-26
 
 ### Fixed

CONTRIBUTING.md

@@ -1,3 +1,7 @@
 # Contributing
 
 Please check out common DSC Community [contributing guidelines](https://dsccommunity.org/guidelines/contributing).
+
+## Running the Tests
+
+If want to know how to run this module's tests you can look at the [Testing Guidelines](https://dsccommunity.org/guidelines/testing-guidelines/#running-tests)

GitVersion.yml

@@ -1,6 +1,6 @@
 mode: ContinuousDelivery
 next-version: 0.1.0
-major-version-bump-message: '\s?(breaking|major|breaking\schange)'
+major-version-bump-message: '(breaking\schange|breaking|major)\b'
 minor-version-bump-message: '(adds?|features?|minor)\b'
 patch-version-bump-message: '\s?(fix|patch)'
 no-bump-message: '\+semver:\s?(none|skip)'

LICENSE

@@ -1,4 +1,4 @@
-The MIT License (MIT)
+MIT License
 
 Copyright (c) DSC Community contributors.
 
@@ -9,13 +9,13 @@ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 copies of the Software, and to permit persons to whom the Software is
 furnished to do so, subject to the following conditions:
 
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
 
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,14 +1,14 @@
 # DscResource.DocGenerator
 
+Functionality to help generate documentation for modules.
+
 [![Build Status](https://dev.azure.com/dsccommunity/DscResource.DocGenerator/_apis/build/status/dsccommunity.DscResource.DocGenerator?branchName=main)](https://dev.azure.com/dsccommunity/DscResource.DocGenerator/_build/latest?definitionId=19&branchName=main)
 ![Azure DevOps coverage (branch)](https://img.shields.io/azure-devops/coverage/dsccommunity/DscResource.DocGenerator/19/main)
 [![codecov](https://codecov.io/gh/dsccommunity/DscResource.DocGenerator/branch/main/graph/badge.svg)](https://codecov.io/gh/dsccommunity/DscResource.DocGenerator)
 [![Azure DevOps tests](https://img.shields.io/azure-devops/tests/dsccommunity/DscResource.DocGenerator/19/main)](https://dsccommunity.visualstudio.com/DscResource.DocGenerator/_test/analytics?definitionId=19&contextType=build)
 [![PowerShell Gallery (with prereleases)](https://img.shields.io/powershellgallery/vpre/DscResource.DocGenerator?label=DscResource.DocGenerator%20Preview)](https://www.powershellgallery.com/packages/DscResource.DocGenerator/)
 [![PowerShell Gallery](https://img.shields.io/powershellgallery/v/DscResource.DocGenerator?label=DscResource.DocGenerator)](https://www.powershellgallery.com/packages/DscResource.DocGenerator/)
 
-Functionality to help generate documentation for modules.
-
 ## Code of Conduct
 
 This project has adopted this [Code of Conduct](CODE_OF_CONDUCT.md).
@@ -22,9 +22,13 @@ full release to [PowerShell Gallery](https://www.powershellgallery.com/).
 
 ## Contributing
 
-Please check out the DSC Community [contributing guidelines](https://dsccommunity.org/guidelines/contributing).
+Please check out common DSC Community [contributing guidelines](https://dsccommunity.org/guidelines/contributing).
 This repository align to the [DSC Community Style Guidelines](https://dsccommunity.org/styleguidelines).
 
+## Change log
+
+A full list of changes in each version can be found in the [change log](CHANGELOG.md).
+
 ## Known Issues
 
 ### Composite Resources and Linux

RequiredModules.psd1

@@ -3,7 +3,7 @@
         AddToPath  = $true
         Target     = 'output\RequiredModules'
         Parameters = @{
-            Repository = ''
+            Repository = 'PSGallery'
         }
     }
 
@@ -12,6 +12,7 @@
     Pester                      = '4.10.1'
     Plaster                     = 'latest'
     ModuleBuilder               = 'latest'
+    ChangelogManagement         = 'latest'
 
     Sampler                     = @{
         version = 'latest'
@@ -22,10 +23,10 @@
 
     'Sampler.GitHubTasks'       = 'latest'
     MarkdownLinkCheck           = 'latest'
-    ChangelogManagement         = 'latest'
     'DscResource.Test'          = 'latest'
     'DscResource.AnalyzerRules' = 'latest'
     xDscResourceDesigner        = 'latest'
+
     # Build dependent modules
     'DscResource.Common'        = 'latest'
 }