Skip to content

Commit

Permalink
chore: release preparation
Browse files Browse the repository at this point in the history
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`.
- Added Community documentation with maintainers and key collaborators.

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.
- Updated `Author` to "VMware".

Signed-off-by: Ryan Johnson <[email protected]>
  • Loading branch information
tenthirtyam committed Jun 27, 2023
1 parent f4c455b commit cd93256
Show file tree
Hide file tree
Showing 12 changed files with 130 additions and 62 deletions.
10 changes: 5 additions & 5 deletions .github/ISSUE_TEMPLATE/bug.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand All @@ -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
Expand All @@ -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
Expand All @@ -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
Expand Down
3 changes: 3 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -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.
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
73 changes: 49 additions & 24 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -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.
-->
4 changes: 2 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -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:

Expand Down
40 changes: 22 additions & 18 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -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.
16 changes: 8 additions & 8 deletions VMware.CloudFoundation.Reporting.psd1
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
#
# Generated by: Gary Blake, Cloud Infrastructure Business Group (CIBG)
#
# Generated on: 06/27/2023
# Generated on: 2023-06-27
#

@{
Expand All @@ -21,13 +21,13 @@
GUID = '043bbd4d-206a-4520-87f5-070450379d72'

# Author of this module
Author = 'Gary Blake, Ryan Johnson, Ivaylo Ivanov, Antony Stefanov - Cloud Infrastructure Business Group (CIBG)'
Author = 'VMware'

# Company or vendor of this module
CompanyName = 'VMware Inc.'

# Copyright statement for this module
Copyright = '(c) 2022-2023 VMware All rights reserved'
Copyright = 'Copyright (c) 2022-2023 VMware, Inc. All rights reserved.'

# Description of the functionality provided by this module
Description = 'PowerShell Module for VMware Cloud Foundation Reporting'
Expand Down Expand Up @@ -95,19 +95,19 @@
PSData = @{

# Tags applied to this module. These help with module discovery in online galleries.
Tags = @('VMware', 'CloudFoundation', 'VMwareCloudFoundation')
Tags = @('VMware', 'CloudFoundation', 'VMwareCloudFoundation')

# A URL to the license for this module.
LicenseUri = 'https://github.com/vmware/powershell-module-for-vmware-cloud-foundation-reporting/blob/main/LICENSE'
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'
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 = ''
Expand Down
2 changes: 1 addition & 1 deletion VMware.CloudFoundation.Reporting.psm1
Original file line number Diff line number Diff line change
Expand Up @@ -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) {
Expand Down
35 changes: 35 additions & 0 deletions docs/community/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# Community

This PowerShell module is the work of many contributors and the project team appreciates your help!

Thank you for your interest in the project. Whether it's a bug report, enhancement, correction, or
additional documentation, we greatly value feedback and contributions from our community.

## Maintainers

### Gary Blake

Senior Staff Solutions Architect, VMware</br>
:fontawesome-brands-github: &nbsp; [@GaryJBlake](https://github.com/GaryJBlake) &nbsp;&nbsp;
:fontawesome-brands-twitter: &nbsp; [@GaryJBlake](https://twitter.com/GaryJBlake) &nbsp;&nbsp;
:fontawesome-brands-chrome: &nbsp; [my-cloudy-world.com](https://my-cloudy-world.com)

### Ryan Johnson

Senior Staff Solutions Architect, VMware</br>
:fontawesome-brands-github: &nbsp; [@tenthirtyam](https://github.com/tenthirtyam) &nbsp;&nbsp;
:fontawesome-brands-mastodon: &nbsp; [@tenthirtyam](https://mastodon.social/@tenthirtyam) &nbsp;&nbsp;
:fontawesome-brands-twitter: &nbsp; [@tenthirtyam](https://twitter.com/tenthirtyam) &nbsp;&nbsp;
:fontawesome-brands-chrome: &nbsp; [tenthirtyam.org](https://tenthirtyam.org)

## Collaborators

### Ivaylo Ivanov

Staff Solution Architect, VMware</br>
:fontawesome-brands-github: &nbsp; [@joisika](https://github.com/joisika)

### Antony Stefanov

Solution Adoption Manager, VMware</br>
:fontawesome-brands-github: &nbsp; [@antonystefanov](https://github.com/antonystefanov)
4 changes: 2 additions & 2 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 }
Expand Down Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion docs/snippets/install-module.ps1
Original file line number Diff line number Diff line change
Expand Up @@ -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
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -236,6 +236,7 @@ nav:
- Request-VsanAlert: documentation/functions/Request-VsanAlert.md
- Test-VcfReportingPrereq: documentation/functions/Test-VcfReportingPrereq.md
- Community:
- community/index.md
- Contributing: community/contributing.md
- Discussions: https://github.com/vmware/powershell-module-for-vmware-cloud-foundation-reporting/discussions
- Search Issues: https://github.com/vmware/powershell-module-for-vmware-cloud-foundation-reporting/issues
Expand Down

0 comments on commit cd93256

Please sign in to comment.