Fixes #27 - added additional documentation

.github/CHANGELOG.md

@@ -5,7 +5,7 @@ All notable changes to this project will be documented in this file.
 The format is based on [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).
 
-## [0.9.4]
+## [0.9.5]
 
 - Catesta template module changes
   - Fixed missing !Sub Intrinsic function reference in PowerShellCodeBuildGit.yml
@@ -15,11 +15,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
     - Resolved bug where CreateMarkdownHelp fails if module not imported
     - Added additional checks for missing markdown documentation
     - Added build steps which import the module manifest explicitly
+    - Corrected output in AnalyzeTests to not write out the word green
 - Catesta primary module changes
   - Improved PSModule.build.ps1
     - Resolved bug where CreateMarkdownHelp fails if module not imported
     - Added additional checks for missing markdown documentation
     - Added build steps which import the module manifest explicitly
+- Updated a few areas of documentation/help to provide more clarification
 
 ## [0.9.0]
 

README.md

@@ -105,7 +105,16 @@ New-PowerShellProject -CICDChoice 'ModuleOnly' -DestinationPath c:\path\ModuleOn
 1. Write your module (the hardest part)
     * All build testing can be done locally by navigating to src and running ```Invoke-Build```
     * If using VSCode as your primary editor you can use tasks to perform various local actions
-      * ```Press Ctrl+P, then type 'task test'```
+      * Examples:
+        * ```Press Ctrl+P, then type 'task .'``` - Runs complete build (all tasks)
+        * ```Press Ctrl+P, then type 'task Test'``` - Invokes all Pester Unit Tests
+        * ```Press Ctrl+P, then type 'task Analyze'``` - Invokes Script Analyzer checks
+        * ```Press Ctrl+P, then type 'task DevCC'``` - Generates generate xml file to graphically display code coverage in VSCode using [Coverage Gutters](https://marketplace.visualstudio.com/items?itemName=ryanluker.vscode-coverage-gutters)
+1. Add any module dependencies to your CI/CD bootstrap file:
+    * AWS: install_modules.ps1
+    * GitHub Actions: actions_bootstrap.ps1
+    * Azure: actions_bootstrap.ps1
+    * AppVeyor: actions_bootstrap.ps1
 1. Commit your project to desired repository that is integrated with your CI/CD platform. This will trigger the build actions.
 1. Evaluate results of your builds and [display your README badges](https://github.com/techthoughts2/Catesta/blob/master/docs/Catesta-FAQ.md#how-do-i-display-the-badges-for-my-project) proudly!
 

docs/Catesta.md

@@ -2,7 +2,7 @@
 Module Name: Catesta
 Module Guid: 6796b193-9013-468a-b022-837749af2d06
 Download Help Link: NA
-Help Version: 0.9.4
+Help Version: 0.9.5
 Locale: en-US
 ---
 

src/Catesta.build.ps1

@@ -24,11 +24,17 @@
     This will perform only the Analyze and Test Add-BuildTasks.
 .NOTES
     This build will pull in configurations from the "<module>.Settings.ps1" file as well, where users can more easily customize the build process if required.
-    The 'InstallDependencies' Add-BuildTask isn't present here. pre-requisite modules are installed at a previous step in the pipeline.
     https://github.com/nightroman/Invoke-Build
     https://github.com/nightroman/Invoke-Build/wiki/Build-Scripts-Guidelines
     If using VSCode you can use the generated tasks.json to execute the various tasks in this build file.
         Ctrl + P | then type task (add space) - you will then be presented with a list of available tasks to run
+    The 'InstallDependencies' Add-BuildTask isn't present here.
+        Module dependencies are installed at a previous step in the pipeline.
+        If your manifest has module dependencies include all required modules in your CI/CD bootstrap file:
+            AWS - install_modules.ps1
+            Azure - actions_bootstrap.ps1
+            GitHub Actions - actions_bootstrap.ps1
+            AppVeyor  - actions_bootstrap.ps1
 #>
 
 #Include: Settings

src/Catesta/Catesta.psd1

@@ -12,7 +12,7 @@
     RootModule        = 'Catesta.psm1'
 
     # Version number of this module.
-    ModuleVersion     = '0.9.4'
+    ModuleVersion     = '0.9.5'
 
     # Supported PSEditions
     # CompatiblePSEditions = @()

src/Catesta/Resources/Module/src/PSModule.build.ps1

@@ -24,11 +24,17 @@
     This will perform only the Analyze and Test Add-BuildTasks.
 .NOTES
     This build will pull in configurations from the "<module>.Settings.ps1" file as well, where users can more easily customize the build process if required.
-    The 'InstallDependencies' Add-BuildTask isn't present here. pre-requisite modules are installed at a previous step in the pipeline.
     https://github.com/nightroman/Invoke-Build
     https://github.com/nightroman/Invoke-Build/wiki/Build-Scripts-Guidelines
     If using VSCode you can use the generated tasks.json to execute the various tasks in this build file.
         Ctrl + P | then type task (add space) - you will then be presented with a list of available tasks to run
+    The 'InstallDependencies' Add-BuildTask isn't present here.
+        Module dependencies are installed at a previous step in the pipeline.
+        If your manifest has module dependencies include all required modules in your CI/CD bootstrap file:
+            AWS - install_modules.ps1
+            Azure - actions_bootstrap.ps1
+            GitHub Actions - actions_bootstrap.ps1
+            AppVeyor  - actions_bootstrap.ps1
 #>
 
 #Include: Settings
@@ -194,7 +200,7 @@ Add-BuildTask AnalyzeTests -After Analyze {
             throw '      One or more PSScriptAnalyzer errors/warnings where found.'
         }
         else {
-            Write-Build White Green '      ...Test Analyze Complete!'
+            Write-Build Green '      ...Test Analyze Complete!'
         }
     }
 }#AnalyzeTests