chore: release preparation

Templates: - Updated placeholders in versions in bug template. - Updated the pull request template. - Corrected type in docs template Documentation: - Updated `PowerValidatedSolutions` dependency to v2.4.0. - Updated `CHANGELOG.md`. License: - Updated `LICENSE` file to allign with other modules and for GitHub recognize as BSD-2. Module: - Updated `ProjectURL` and `ReleaseNotes` to GitHub Pages URLs. - Updated date on module manifest. - Updated date to ISO standard. - Updated `Copywrite` format. Signed-off-by: Ryan Johnson <[email protected]>
vmware · Jun 21, 2023 · 1751509 · 1751509
1 parent f4c455b
commit 1751509
Show file tree

Hide file tree

Showing 10 changed files with 90 additions and 58 deletions.
diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml
@@ -29,7 +29,7 @@ body:
     attributes:
       label: VMware Cloud Foundation
       description: Please provide the VMware Cloud Foundation version.
-      placeholder: v4.5
+      placeholder: 5.0
     validations:
       required: true
   - type: input
@@ -51,7 +51,7 @@ body:
         Please provide the VMware PowerCLI version.
         
         Results of `Get-InstalledModule VMware.PowerCLI`
-      placeholder: v12.7.0
+      placeholder: 13.0.0
     validations:
       required: true
   - type: input
@@ -62,7 +62,7 @@ body:
         Please provide the PowerShell module version.
         
         Results of: `Get-InstalledModule VMware.CloudFoundation.Reporting`
-      placeholder: v1.0.4
+      placeholder: 2.2.0
     validations:
       required: true
   - type: input
@@ -73,7 +73,7 @@ body:
         Please provide the PowerShell module version.
         
         Results of: `Get-InstalledModule PowerValidatedSolutions`
-      placeholder: v1.9.0
+      placeholder: 2.4.0
     validations:
       required: true
   - type: input
@@ -84,7 +84,7 @@ body:
         Please provide the PowerVCF version.
         
         Results of `Get-InstalledModule PowerVCF`
-      placeholder: v2.2.0
+      placeholder: 2.3.0
     validations:
       required: true
   - type: input

diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
@@ -1,5 +1,8 @@
 blank_issues_enabled: false
 contact_links:
+  - name: Module Documentation
+    url: 'https://vmware.github.io/powershell-module-for-vmware-cloud-foundation-reporting'
+    about: Having trouble with the module? Check out the documentation.
   - name: VMware Cloud Foundation Product Documentation
     url: https://vmware.com/go/vcf-docs
     about: Manage VM and container-based workloads with the hybrid cloud platform, built on full stack hyper-converged infrastructure.
diff --git a/.github/ISSUE_TEMPLATE/docs.yml b/.github/ISSUE_TEMPLATE/docs.yml
@@ -8,7 +8,7 @@ body:
   - type: markdown
     attributes:
       value: >
-        When filing a documentation issue, please include the followinginformation.
+        When filing a documentation issue, please include the following information.
   - type: checkboxes
     id: terms
     attributes:

diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
@@ -1,52 +1,77 @@
-In order to have a good experience with our community, we recommend that you read the [contributing guidelines](https://github.com/vmware/powershell-module-for-cloud-foundation-reorting/blob/main/CONTRIBUTING_DCO.md) for making a pull request.
+<!-- markdownlint-disable first-line-h1 no-inline-html -->
 
-**Summary of Pull Request**
+<!--
+    In order to have the best experience with our community, we recommend that you read the code of conduct and contributing guidelines before submitting a pull request.
+    
+    By submitting this pull request, you confirm that you have read, understood, and agreed to the project's code of conduct and contributing guidelines.
+
+    Please use conventional commits to format the title of the pull request and the commit messages.
+    For more information, please refer to https://www.conventionalcommits.org.
+-->
+
+### Summary
 
 <!--
     Please provide a clear and concise description of the pull request.
 -->
 
-**Type of Pull Request**
+### Type
 
 <!--
-    Please check the one that applies to this pull request using "x".
+    Please check the one(s) that applies to this pull request using "x".
 -->
 
-- [ ] This is a bug fix.
-- [ ] This is an enhancement or feature.
-- [ ] This is a code style / formatting update.
-- [ ] This is a documentation update.
-- [ ] This is a refactoring update.
-- [ ] This is a chore update
-- [ ] This is something else.
-      Please describe:
+- [ ] Bugfix
+- [ ] Enhancement or Feature
+- [ ] Code Style or Formatting
+- [ ] Documentation
+- [ ] Refactoring
+- [ ] Chore
+- [ ] Other
+        Please describe:
 
-**Related to Existing Issues**
+### Breaking Changes?
 
 <!--
-  Is this related to any GitHub issue(s)?
+    Please check the one that applies to this pull request using "x".
+    If this pull request contains a breaking change, please describe the impact and mitigation path.
 -->
 
-Issue Number: N/A
+- [ ] Yes, there are breaking changes.
+- [ ] No, there are no breaking changes.
 
-**Test and Documentation Coverage**
+### Test and Documentation
 
 <!--
-    Please check the one that applies to this pull request using "x".
+    Please check the one(s) that applies to this pull request using "x".
+    For bug fixes and enhancements/features, please ensure that tests and documentation have been completed and provide details.
 -->
 
-- [ ] Tests have been completed (for bug fixes / features).
-- [ ] Documentation has been added / updated (for bug fixes / features).
+- [ ] Tests have been completed.
+- [ ] Documentation has been added or updated.
 
-**Breaking Changes?**
+<!--
+    Please describe the tests that have been completed and/or the documentation that has been added/updated.
+-->
+
+### Issue References
 
 <!--
-    Please check the one that applies to this pull request using "x".
+    Is this related to any GitHub issue(s)? If so, please provide the issue number(s) that are closed or resolved by this pull request.
+
+    For bug fixes and enhancements/features, please ensure that a GitHub issue has been created and provide the issue number(s) here.
+
+    Please use the 'Closes' keyword followed by the a hash and issue number.
+    This will link the pull request to the issue(s) and automatically close them when the pull request is merged.
+
+    Example:
+
+    Closes #000
+    Closes #001
 -->
 
-- [ ] Yes, there are breaking changes.
-- [ ] No, there are no breaking changes.
+### Additional Information
 
 <!--
-    If this pull request contains a breaking change, please describe the impact and mitigation path.
+    Please provide any additional information that may be helpful.
 -->
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,8 +1,8 @@
 # Release History
 
-## v2.2.0 (Unreleases)
+## [v2.2.0](https://github.com/vmware/powershell-module-for-vmware-cloud-foundation-reporting/releases/tag/v2.2.0)
 
-> Release Date: Unreleased
+> Release Date: 2023-06-27
 
 Bugfix:
 

diff --git a/LICENSE b/LICENSE
@@ -1,24 +1,28 @@
-PowerShell Module for VMware Cloud Foundation Reporting
-Copyright 2022-2023 VMware, Inc.
+BSD 2-Clause License
 
-The BSD-2 license (the "License") set forth below applies to all parts of the project. You may not use this file
-except in compliance with the License.
+Copyright (c) 2022-2023, VMware, Inc.
+All rights reserved.
 
-BSD-2 License
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are
+met:
 
-Redistribution and use in source and binary forms, with or without modification, are permitted provided that the
-following conditions are met:
+   1. Redistributions of source code must retain the above copyright
+      notice, this list of conditions and the following disclaimer.
 
-Redistributions of source code must retain the above copyright notice, this list of conditions and the following
-disclaimer.
+   2. Redistributions in binary form must reproduce the above
+      copyright notice, this list of conditions and the following
+      disclaimer in the documentation and/or other materials provided
+      with the distribution.
 
-Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following
-disclaimer in the documentation and/or other materials provided with the distribution.
-
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
-INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
-DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
-SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
-SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
-WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT
+HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
diff --git a/VMware.CloudFoundation.Reporting.psd1 b/VMware.CloudFoundation.Reporting.psd1
@@ -3,7 +3,7 @@
 #
 # Generated by: Gary Blake, Cloud Infrastructure Business Group (CIBG)
 #
-# Generated on: 06/27/2023
+# Generated on: 2023-06-27
 #
 
 @{
@@ -27,7 +27,7 @@
     CompanyName = 'VMware Inc.'
 
     # Copyright statement for this module
-    Copyright = '(c) 2022-2023 VMware All rights reserved'
+    Copyright = 'Copyright 2022-2023 VMware, Inc.'
 
     # Description of the functionality provided by this module
     Description = 'PowerShell Module for VMware Cloud Foundation Reporting'
@@ -101,13 +101,13 @@
             LicenseUri = 'https://github.com/vmware/powershell-module-for-vmware-cloud-foundation-reporting/blob/main/LICENSE'
 
             # A URL to the main website for this project.
-            ProjectUri = 'https://github.com/vmware/powershell-module-for-vmware-cloud-foundation-reporting'
+            ProjectUri = 'https://vmware.github.io/powershell-module-for-vmware-cloud-foundation-reporting'
 
             # A URL to an icon representing this module.
             IconUri = 'https://raw.githubusercontent.com/vmware/powershell-module-for-vmware-cloud-foundation-reporting/main/.github/icon-85px.svg'
 
             # ReleaseNotes of this module
-            ReleaseNotes = 'https://github.com/vmware/powershell-module-for-vmware-cloud-foundation-reporting/blob/main/CHANGELOG.md'
+            ReleaseNotes = 'https://vmware.github.io/powershell-module-for-vmware-cloud-foundation-reporting/release-notes/'
 
             # Prerelease string of this module
             # Prerelease = ''

diff --git a/VMware.CloudFoundation.Reporting.psm1 b/VMware.CloudFoundation.Reporting.psm1
@@ -9262,7 +9262,7 @@ Function Test-VcfReportingPrereq {
             @{ Name=("VMware.PowerCLI"); MinimumVersion=("13.0.0")}
             @{ Name=("VMware.vSphere.SsoAdmin"); MinimumVersion=("1.3.9")}
             @{ Name=("PowerVCF"); MinimumVersion=("2.3.0")}
-            @{ Name=("PowerValidatedSolutions"); MinimumVersion=("2.2.0")}
+            @{ Name=("PowerValidatedSolutions"); MinimumVersion=("2.4.0")}
         )
 
         if (Test-VCFConnection -server $sddcManagerFqdn) {

diff --git a/docs/index.md b/docs/index.md
@@ -15,7 +15,7 @@
 The following table lists the supported platforms for this module.
 
 Platform                                                     | vSAN ReadyNodes                     | DellEMC VxRail
--------------------------------------------------------------|-------------------------------------|--------------------------
+-------------------------------------------------------------|-------------------------------------|------------------------------------
 :fontawesome-solid-cloud: &nbsp; VMware Cloud Foundation 5.0 | :fontawesome-solid-check:{ .green } | :fontawesome-solid-check:{ .green }
 :fontawesome-solid-cloud: &nbsp; VMware Cloud Foundation 4.5 | :fontawesome-solid-check:{ .green } | :fontawesome-solid-check:{ .green }
 :fontawesome-solid-cloud: &nbsp; VMware Cloud Foundation 4.4 | :fontawesome-solid-check:{ .green } | :fontawesome-solid-check:{ .green }
@@ -49,7 +49,7 @@ PowerShell Module                                    | Version   | Publisher
 [VMware.PowerCLI][psgallery-module-powercli]         | >= 13.0.0 | VMware, Inc. | :fontawesome-solid-book: &nbsp; [Documentation][developer-module-powercli]
 [VMware.vSphere.SsoAdmin][psgallery-module-ssoadmin] | >= 1.3.9  | VMware, Inc. | :fontawesome-brands-github: &nbsp; [GitHub][github-module-ssoadmin]
 [PowerVCF][psgallery-module-powervcf]                | >= 2.3.0  | VMware, Inc. | :fontawesome-brands-github: &nbsp; [GitHub][github-module-powervcf]
-[PowerValidatedSolutions][psgallery-module-pvs]      | >= 2.2.0  | VMware, Inc. | :fontawesome-brands-github: &nbsp; [GitHub][github-module-pvs]
+[PowerValidatedSolutions][psgallery-module-pvs]      | >= 2.4.0  | VMware, Inc. | :fontawesome-brands-github: &nbsp; [GitHub][github-module-pvs]
 
 ### Browsers
 

diff --git a/docs/snippets/install-module.ps1 b/docs/snippets/install-module.ps1
@@ -2,5 +2,5 @@ Set-PSRepository -Name PSGallery -InstallationPolicy Trusted
 Install-Module -Name VMware.PowerCLI -MinimumVersion 13.0.0
 Install-Module -Name VMware.vSphere.SsoAdmin -MinimumVersion 1.3.9
 Install-Module -Name PowerVCF -MinimumVersion 2.3.0
-Install-Module -Name PowerValidatedSolutions -MinimumVersion 2.2.0
+Install-Module -Name PowerValidatedSolutions -MinimumVersion 2.4.0
 Install-Module -Name VMware.CloudFoundation.Reporting