chore: release preparation

- Reviewed and Updated README.md - Updated GUID in PowerVCF.psd1 - Updated release date CHANGELOG.md - Updated formatting in CODE_OF_CONDUCT.md - Updated formatting in CONTRIBUTING.md - Updated formatting and copyright date in LICENSE - Updated formatting and copyright date in NOTICE Signed-off-by: Gary Blake <[email protected]>
vmware · Apr 25, 2023 · 35b95a8 · 35b95a8
1 parent a1544ba
commit 35b95a8
Show file tree

Hide file tree

Showing 7 changed files with 104 additions and 81 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,6 +1,6 @@
 # Release History
 
-## v2.3.0 (Not Released)
+## v2.3.0 (2023-04-25)
 
 - Enhanced `validateJsonInput` cmdlet for consistency across functions.
 - Enhanced `Get-VCFDepotCredential` cmdlet to support retrieving the VxRail depot details.

diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
@@ -29,45 +29,63 @@ Examples of unacceptable behavior include:
 
 ## Enforcement Responsibilities
 
-Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take
+appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening,
+offensive, or harmful.
 
-Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits,
+issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for
+moderation decisions when appropriate.
 
 ## Scope
 
-This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official email address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially
+representing the community in public spaces. Examples of representing our community include using an official email
+address, posting via an official social media account, or acting as an appointed representative at an online or
+offline event.
 
 ## Enforcement
 
-Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at [email protected]. All complaints will be reviewed and investigated promptly and fairly.
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders
+responsible for enforcement at [email protected]. All complaints will be reviewed and investigated promptly and fairly.
 
 All community leaders are obligated to respect the privacy and security of the reporter of any incident.
 
 ## Enforcement Guidelines
 
-Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they
+deem in violation of this Code of Conduct:
 
 ### 1. Correction
 
-**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the
+community.
 
-**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the
+violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
 
 ### 2. Warning
 
 **Community Impact**: A violation through a single incident or series of actions.
 
-**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including
+unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes
+avoiding interactions in community spaces as well as external channels like social media. Violating these terms may
+lead to a temporary or permanent ban.
 
 ### 3. Temporary Ban
 
 **Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
 
-**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a
+specified period of time. No public or private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent
+ban.
 
 ### 4. Permanent Ban
 
-**Community Impact**: Demonstrating a pattern of violation of communitystandards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate
+behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
 
 **Consequence**: A permanent ban from any sort of public interaction within the community.
 

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -1,6 +1,7 @@
 # Contributing Guidelines
 
-Thank you for your interest in contributing to our project. Whether it's a bug report, new feature, correction, or additional documentation, we greatly value feedback and contributions from our community.
+Thank you for your interest in contributing to our project. Whether it's a bug report, new feature, correction, or
+additional documentation, we greatly value feedback and contributions from our community.
 
 Please read through this document before submitting any issues or pull requests to ensure we have all the necessary
 information to effectively respond to your bug report or contribution.
@@ -24,17 +25,18 @@ Contributions via pull requests are appreciated. Before sending us a pull reques
 
 1. You open an issue and link your pull request to the issue for context.
 2. You are working against the latest source on the `main` branch.
-3. You check existing open, and recently merged, pull requests to make sure someone else hasn't already addressed the problem.
+3. You check existing open, and recently merged, pull requests to make sure someone else hasn't already addressed the
+problem.
 
 To send us a pull request, please:
 
 1. Fork the repository.
 2. Modify the source; please focus on the **specific** change you are contributing.
 3. Ensure local tests pass.
 4. Updated the documentation, if required.
-4. Commit to your fork [using a clear commit messages](http://chris.beams.io/posts/git-commit/).
-5. Send us a pull request, answering any default questions in the pull request.
-6. Pay attention to any automated failures reported in the pull request, and stay involved in the conversation.
+5. Commit to your fork [using a clear commit messages](http://chris.beams.io/posts/git-commit/).
+6. Send us a pull request, answering any default questions in the pull request.
+7. Pay attention to any automated failures reported in the pull request, and stay involved in the conversation.
 
 GitHub provides additional document on [forking a repository](https://help.github.com/articles/fork-a-repo/) and
 [creating a pull request](https://help.github.com/articles/creating-a-pull-request/).
@@ -71,9 +73,11 @@ git push --force-with-lease origin my-new-feature
 
 ### Updating Pull Requests
 
-If your pull request fails to pass or needs changes based on code review, you'll most likely want to squash these changes into existing commits.
+If your pull request fails to pass or needs changes based on code review, you'll most likely want to squash these
+changes into existing commits.
 
-If your pull request contains a single commit or your changes are related to the most recent commit, you can simply amend the commit.
+If your pull request contains a single commit or your changes are related to the most recent commit, you can simply
+amend the commit.
 
 ``` shell
 git add .
@@ -90,15 +94,17 @@ git rebase -i --autosquash master
 git push --force-with-lease origin my-new-feature
 ```
 
-Be sure to add a comment to the pull request indicating your new changes are ready to review, as GitHub does not generate a notification when you `git push`.
+Be sure to add a comment to the pull request indicating your new changes are ready to review, as GitHub does not
+generate a notification when you `git push`.
 
 ### Formatting Commit Messages
 
 We follow the conventions on [How to Write a Git Commit Message](http://chris.beams.io/posts/git-commit/).
 
 Be sure to include any related GitHub issue references in the commit message.
 
-See [GFM syntax](https://guides.github.com/features/mastering-markdown/#GitHub-flavored-markdown) for referencing issues and commits.
+See [GFM syntax](https://guides.github.com/features/mastering-markdown/#GitHub-flavored-markdown) for referencing
+issues and commits.
 
 ## Reporting Bugs and Creating Issues
 
@@ -110,6 +116,7 @@ Looking at the existing issues is a great way to find something to contribute on
 
 ## Licensing
 
-See the [LICENSE](LICENSE) file for our project's licensing. We will ask you to confirm the licensing of your contribution.
+See the [LICENSE](LICENSE) file for our project's licensing. We will ask you to confirm the licensing of your
+contribution.
 
 We may ask you to sign a [Contributor License Agreement (CLA)](http://en.wikipedia.org/wiki/Contributor_License_Agreement) for larger changes.
diff --git a/LICENSE b/LICENSE
@@ -1,25 +1,21 @@
 BSD 2-Clause License
 
-Copyright (c) 2020-2022, VMware, Inc.
+Copyright (c) 2020-2023, VMware, Inc.
 All rights reserved.
 
-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.
+1. 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.
+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.
 
-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.
+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/NOTICE b/NOTICE
@@ -1,5 +1,7 @@
-Copyright 2020-2022 VMware, Inc. All Rights Reserved.
+Copyright 2020-2023 VMware, Inc. All Rights Reserved.
 
-This product is licensed to you under the BSD-2 license (the "License").  You may not use this product except in compliance with the BSD-2 License.
+This product is licensed to you under the BSD-2 license (the "License").  You may not use this product except in
+compliance with the BSD-2 License.
 
-This product may include a number of subcomponents with separate copyright notices and license terms. Your use of these subcomponents is subject to the terms and conditions of the subcomponent's license, as noted in the LICENSE file.
+This product may include a number of subcomponents with separate copyright notices and license terms. Your use of
+these subcomponents is subject to the terms and conditions of the subcomponent's license, as noted in the LICENSE file.
diff --git a/PowerVCF.psd1 b/PowerVCF.psd1
@@ -1,9 +1,9 @@
 #
 # Module manifest for module 'PowerVCF'
 #
-# Generated by: Brian O Connell
+# Generated by: Gary Blake
 #
-# Generated on: 26/05/2022
+# Generated on: 25/04/20234
 #
 
 @{
@@ -18,7 +18,7 @@ ModuleVersion = '2.3.0.1004'
 # CompatiblePSEditions = @()
 
 # ID used to uniquely identify this module
-GUID = '08d28c56-f241-4a8c-8806-dee337cf74c9'
+GUID = '06d28d36-f241-4a8b-8806-dee37cf74c9'
 
 # Author of this module
 Author = 'Brian O Connell, Gary Blake & Ken Gould'
@@ -30,7 +30,7 @@ CompanyName = 'VMware Inc.'
 Copyright = 'Copyright 2021-2023 VMware, Inc.'
 
 # Description of the functionality provided by this module
-Description = 'PowerShell Module for the VMware Cloud Foundation 4.x API.'
+Description = 'PowerShell Module for the VMware Cloud Foundation 4.x API'
 
 # Minimum version of the Windows PowerShell engine required by this module
 # PowerShellVersion = '5.0'

diff --git a/README.md b/README.md
@@ -53,25 +53,53 @@ VMware Cloud Foundation
 
 Verify that your system has a supported edition and version of PowerShell installed.
 
-### From the PowerShell Gallery
-
 Install the module from the PowerShell Gallery by opening a PowerShell session as an Administrator and running the following command:
 
 ```powershell
 Install-Module -Name PowerVCF
 ```
 
-### From Source
+## Updating the Module
+
+Update the PowerShell module to the latest release from the Microsoft PowerShell Gallery by running the following command in the PowerShell console:
+
+```powershell
+Update-Module -Name PowerVCF
+```
+
+To verify the version of the PowerShell module, run the following command in the PowerShell console.
+
+```powershell
+Get-InstalledModule -Name PowerVCF
+```
+
+## Getting Help
+
+To view the cmdlets available in the module, run the following command in the PowerShell console.
+
+```powershell
+Get-Command -Module PowerVCF
+```
+
+To view the help for any cmdlet, run the `Get-Help` command in the PowerShell console.
+
+For example:
+
+```powershell
+Get-Help -Name Request-VCFToken
+```
 
-Install the module from the from source first downloading and extracting the [release][module-powervcf-releases] archive. Next, open a PowerShell session as an Administrator, navigate to the directory where the binary has been extracted, and run the following command:
+```powershell
+Get-Help -Name Request-VCFToken -examples
+```
 
 ```powershell
-Import-Module .\PowerVCF
+Get-Help -Name Request-VCFToken -full
 ```
 
 ## Getting Started
 
-All API operations must currently be authenticated using the SDDC Manager. To create a `base64` credential to authenticate each cmdlet you must first run the `Request-VCFToken` cmdlet.
+All API operations must be authenticated via SDDC Manager. To create a `base64` credential to authenticate each cmdlet you must first run the `Request-VCFToken` cmdlet.
 
 This example shows how to connect to SDDC Manager to request API access & refresh tokens using the default `[email protected]` vCenter Single Sign-On administrator account.
 
@@ -147,34 +175,6 @@ $hostDetail.esxiVersion
 7.0.2-17867351
 ```
 
-## Get Help
-
-Once installed, any cmdlets associated with `PowerVCF` will be available for use.
-
-To view the cmdlets for available in the module, run the following command in the PowerShell console.
-
-```powershell
-Get-Command -Module PowerVCF
-```
-
-To view the help for any cmdlet, run the `Get-Help` command in the PowerShell console.
-
-For example:
-
-```powershell
-Get-Help -Name <cmdlet name>
-```
-
-Each cmdlet support the following options:
-
-```powershell
-Get-Help -Name <cmdlet name> -Examples
-
-Get-Help -Name <cmdlet name> -Detailed
-
-Get-Help -Name <cmdlet name> -Full
-```
-
 ## Contributing
 
 The project team welcomes contributions from the community. Before you start working with PowerValidatedSolutions, please read our [Developer Certificate of Origin][vmware-cla-dco]. All contributions to this repository must be signed as described on that page. Your signature certifies that you wrote the patch or have the right to pass it on as an open-source patch.
@@ -189,7 +189,7 @@ If you discover a bug or would like to suggest an enhancement, please [open an i
 
 ## License
 
-Copyright 2021-2022 VMware, Inc.
+Copyright 2021-2023 VMware, Inc.
 
 Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: