Add new module icon and update module private data settings (#5)

* fix(Build): Added project url to manifect and module icon * updated icon images * update changelog
LarryWisherMan · Sep 9, 2024 · de08c3a · de08c3a
1 parent 121e4fe
commit de08c3a
Show file tree

Hide file tree

Showing 7 changed files with 94 additions and 99 deletions.
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -50,6 +50,7 @@
         "Open-RegistryKey",
         "Open-RegistrySubKey",
         "Remove-RegistrySubKey",
-        "tests"
+        "tests",
+        "Build"
     ]
 }
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,6 +5,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Added
+- Added module icon and Psd1 private data
+
 ## [v0.2.0] - 2024-09-08
 
 ### Added

diff --git a/README.md b/README.md
@@ -18,13 +18,3 @@ Typical use cases include:
 - Simplifying registry access in complex automation tasks.
 - Providing a reliable registry management layer for other modules like ProfileManagement.
 - Managing the lifecycle of registry keys during system configuration changes.
-
-## Make it yours
-
----
-Generated with Plaster and the SampleModule template
-
-
-This is a sample Readme
-
-## Make it yours
diff --git a/assets/WinRegOps.png b/assets/WinRegOps.png
diff --git a/assets/WinRegOps2.png b/assets/WinRegOps2.png
diff --git a/build.yaml b/build.yaml
@@ -10,7 +10,7 @@ BuiltModuleSubdirectory: module
 CopyPaths:
   - en-US
 #  - DSCResources
-  # - Modules
+# - Modules
 Encoding: UTF8
 # Can be used to manually specify module's semantic version if the preferred method of
 # using GitVersion is not available, and it is not possible to set the session environment
@@ -49,7 +49,7 @@ NestedModule:
 ####################################################
 # Defining 'Workflows' (suite of InvokeBuild tasks) to be run using their alias
 BuildWorkflow:
-  '.': # "." is the default Invoke-Build workflow. It is called when no -Tasks is specified to the build.ps1
+  ".": # "." is the default Invoke-Build workflow. It is called when no -Tasks is specified to the build.ps1
     - build
     - test
 
@@ -59,13 +59,10 @@ BuildWorkflow:
     - Build_NestedModules_ModuleBuilder
     - Create_changelog_release_output
 
-
   pack:
     - build
     - package_module_nupkg
 
-
-
   # Defining test task to be run when invoking `./build.ps1 -Tasks test`
   test:
     # Uncomment to modify the PSModulePath in the test pipeline (also requires the build configuration section SetPSModulePath).
@@ -79,10 +76,9 @@ BuildWorkflow:
   # Use this task when you have multiple parallel tests, which produce multiple
   # code coverage files and needs to get merged into one file.
   #merge:
-    #- Merge_CodeCoverage_Files
+  #- Merge_CodeCoverage_Files
 
   publish:
-
     - Publish_Release_To_GitHub # Runs first, if token is expired it will fail early
     - publish_module_to_gallery
 
@@ -106,7 +102,7 @@ Pester:
   # - tests/Unit
   # - tests/Integration
   ExcludeTag:
-  #  - helpQuality
+    #  - helpQuality
     - FunctionalQuality
     - TestQuality
   Tag:
@@ -124,20 +120,18 @@ Pester:
 # CodeCoverageMergedOutputFile - the file that is created by the merge build task and
 #                                is the file that should be uploaded to code coverage services.
 #CodeCoverage:
-  #CodeCoverageFilePattern: JaCoCo_Merge.xml # the pattern used to search all pipeline test job artifacts
-  #CodeCoverageMergedOutputFile: JaCoCo_coverage.xml # the file that is created for the merged code coverage
-
+#CodeCoverageFilePattern: JaCoCo_Merge.xml # the pattern used to search all pipeline test job artifacts
+#CodeCoverageMergedOutputFile: JaCoCo_coverage.xml # the file that is created for the merged code coverage
 
 # Import ModuleBuilder tasks from a specific PowerShell module using the build
 # task's alias. Wildcard * can be used to specify all tasks that has a similar
 # prefix and or suffix. The module contain the task must be added as a required
 # module in the file RequiredModules.psd1.
 ModuleBuildTasks:
   Sampler:
-    - '*.build.Sampler.ib.tasks'
+    - "*.build.Sampler.ib.tasks"
   Sampler.GitHubTasks:
-    - '*.ib.tasks'
-
+    - "*.ib.tasks"
 
 # Invoke-Build Header to be used to 'decorate' the terminal output of the tasks.
 TaskHeader: |
@@ -150,3 +144,10 @@ TaskHeader: |
   Write-Build DarkGray "  $Path"
   Write-Build DarkGray "  $($Task.InvocationInfo.ScriptName):$($Task.InvocationInfo.ScriptLineNumber)"
   ""
+
+GitHubConfig:
+  GitHubFilesToAdd:
+    - "CHANGELOG.md"
+  GitHubConfigUserName: LarryWisherMan
+  GitHubConfigUserEmail: MikeRow@upkep.net
+  UpdateChangelogOnPrerelease: false
diff --git a/source/WinRegOps.psd1 b/source/WinRegOps.psd1
@@ -8,29 +8,29 @@
 
 @{
 
-# Script module or binary module file associated with this manifest.
-RootModule = 'WinRegOps.psm1'
+    # Script module or binary module file associated with this manifest.
+    RootModule           = 'WinRegOps.psm1'
 
-# Version number of this module.
-ModuleVersion = '0.0.1'
+    # Version number of this module.
+    ModuleVersion        = '0.0.1'
 
-# Supported PSEditions
-# CompatiblePSEditions = @()
+    # Supported PSEditions
+    # CompatiblePSEditions = @()
 
-# ID used to uniquely identify this module
-GUID = 'eb12e370-5823-4240-8b84-19f48e900808'
+    # ID used to uniquely identify this module
+    GUID                 = 'eb12e370-5823-4240-8b84-19f48e900808'
 
-# Author of this module
-Author = 'LarryWisherMan'
+    # Author of this module
+    Author               = 'LarryWisherMan'
 
-# Company or vendor of this module
-CompanyName = 'LarryWisherMan'
+    # Company or vendor of this module
+    CompanyName          = 'LarryWisherMan'
 
-# Copyright statement for this module
-Copyright = '(c) 2024 LarryWisherMan. All rights reserved.'
+    # Copyright statement for this module
+    Copyright            = '(c) 2024 LarryWisherMan. All rights reserved.'
 
-# Description of the functionality provided by this module
-Description = 'The WinRegOps module provides a comprehensive set of PowerShell functions to interact with the Windows registry, offering a simplified interface for common operations such as reading, writing, and deleting registry keys and values. It acts as a wrapper around the Microsoft.Win32.RegistryKey .NET class, extending its functionality for both local and remote registry operations.
+    # Description of the functionality provided by this module
+    Description          = 'The WinRegOps module provides a comprehensive set of PowerShell functions to interact with the Windows registry, offering a simplified interface for common operations such as reading, writing, and deleting registry keys and values. It acts as a wrapper around the Microsoft.Win32.RegistryKey .NET class, extending its functionality for both local and remote registry operations.
 
 The module is designed to handle tasks like retrieving specific registry values, exporting registry keys, managing subkeys, and removing keys with enhanced error handling. It allows for seamless interaction with the Windows registry across various environments and use cases, such as system configuration, profile management, and application settings.
 
@@ -49,92 +49,92 @@ Typical use cases include:
 - Providing a reliable registry management layer for other modules like ProfileManagement.
 - Managing the lifecycle of registry keys during system configuration changes.'
 
-# Minimum version of the Windows PowerShell engine required by this module
-PowerShellVersion = '5.0'
+    # Minimum version of the Windows PowerShell engine required by this module
+    PowerShellVersion    = '5.0'
 
-# Name of the Windows PowerShell host required by this module
-# PowerShellHostName = ''
+    # Name of the Windows PowerShell host required by this module
+    # PowerShellHostName = ''
 
-# Minimum version of the Windows PowerShell host required by this module
-# PowerShellHostVersion = ''
+    # Minimum version of the Windows PowerShell host required by this module
+    # PowerShellHostVersion = ''
 
-# Minimum version of Microsoft .NET Framework required by this module. This prerequisite is valid for the PowerShell Desktop edition only.
-# DotNetFrameworkVersion = ''
+    # Minimum version of Microsoft .NET Framework required by this module. This prerequisite is valid for the PowerShell Desktop edition only.
+    # DotNetFrameworkVersion = ''
 
-# Minimum version of the common language runtime (CLR) required by this module. This prerequisite is valid for the PowerShell Desktop edition only.
-# CLRVersion = ''
+    # Minimum version of the common language runtime (CLR) required by this module. This prerequisite is valid for the PowerShell Desktop edition only.
+    # CLRVersion = ''
 
-# Processor architecture (None, X86, Amd64) required by this module
-# ProcessorArchitecture = ''
+    # Processor architecture (None, X86, Amd64) required by this module
+    # ProcessorArchitecture = ''
 
-# Modules that must be imported into the global environment prior to importing this module
-RequiredModules = @()
+    # Modules that must be imported into the global environment prior to importing this module
+    RequiredModules      = @()
 
-# Assemblies that must be loaded prior to importing this module
-# RequiredAssemblies = @()
+    # Assemblies that must be loaded prior to importing this module
+    # RequiredAssemblies = @()
 
-# Script files (.ps1) that are run in the caller's environment prior to importing this module.
-# ScriptsToProcess = @()
+    # Script files (.ps1) that are run in the caller's environment prior to importing this module.
+    # ScriptsToProcess = @()
 
-# Type files (.ps1xml) to be loaded when importing this module
-# TypesToProcess = @()
+    # Type files (.ps1xml) to be loaded when importing this module
+    # TypesToProcess = @()
 
-# Format files (.ps1xml) to be loaded when importing this module
-# FormatsToProcess = @()
+    # Format files (.ps1xml) to be loaded when importing this module
+    # FormatsToProcess = @()
 
-# Modules to import as nested modules of the module specified in RootModule/ModuleToProcess
-NestedModules = ''
+    # Modules to import as nested modules of the module specified in RootModule/ModuleToProcess
+    NestedModules        = ''
 
-# 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.
-FunctionsToExport = @()
+    # 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.
+    FunctionsToExport    = @()
 
-# 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 = @()
+    # 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 = @()
+    # 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.
-AliasesToExport = @()
+    # 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.
+    AliasesToExport      = @()
 
-# DSC resources to export from this module
-DscResourcesToExport = @()
+    # DSC resources to export from this module
+    DscResourcesToExport = @()
 
-# List of all modules packaged with this module
-ModuleList = @('WisherTools.Helpers')
+    # List of all modules packaged with this module
+    ModuleList           = @('WisherTools.Helpers')
 
-# List of all files packaged with this module
-# FileList = @()
+    # List of all files packaged with this module
+    # FileList = @()
 
-# 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 = @{
+    # 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 = @{
+        PSData = @{
 
-        Prerelease =  ''
-        # Tags applied to this module. These help with module discovery in online galleries.
-        # Tags = @()
+            Prerelease   = ''
+            # Tags applied to this module. These help with module discovery in online galleries.
+            Tags         = @('Windows', 'Registry', 'RemoteRegistry', 'ProfileManagement', 'SystemConfiguration', 'RegistryOperations', 'Automation', 'PowerShell')
 
-        # A URL to the license for this module.
-        # LicenseUri = ''
+            # A URL to the license for this module.
+            LicenseUri   = 'https://github.com/LarryWisherMan/WinRegOps/blob/main/LICENSE'
 
-        # A URL to the main website for this project.
-        # ProjectUri = ''
+            # A URL to the main website for this project.
+            ProjectUri   = 'https://github.com/LarryWisherMan/WinRegOps'
 
-        # A URL to an icon representing this module.
-        # IconUri = ''
+            # A URL to an icon representing this module.
+            # IconUri = ''
 
-        # ReleaseNotes of this module
-        ReleaseNotes = ''
+            # ReleaseNotes of this module
+            ReleaseNotes = 'https://raw.githubusercontent.com/LarryWisherMan/WinRegOps/main/WinRegOps/assets/WinRegOps.png'
 
-    } # End of PSData hashtable
+        } # End of PSData hashtable
 
-} # End of PrivateData hashtable
+    } # End of PrivateData hashtable
 
-# HelpInfo URI of this module
-# HelpInfoURI = ''
+    # HelpInfo URI of this module
+    # HelpInfoURI = ''
 
-# Default prefix for commands exported from this module. Override the default prefix using Import-Module -Prefix.
-# DefaultCommandPrefix = ''
+    # Default prefix for commands exported from this module. Override the default prefix using Import-Module -Prefix.
+    # DefaultCommandPrefix = ''
 
 }