Skip to content

Commit

Permalink
chore: release preparation #40
Browse files Browse the repository at this point in the history
- Updated CHANGELOG.md for release.
- Updated docs to remove the PowerValidatedSolutions version dependency. Not required.
- Updated docs to add support for VMware Cloud Foundation 5.0.
- Added Makefile for local testing.
- Updated .gitignore to exclude the .site path and files from a local build test.
- Removed banner and footer link. Will be replaced by digital marketing metrics.
- Bump module version and build to v1.2.0.1001.
  • Loading branch information
GaryJBlake authored Jul 25, 2023
2 parents 7745d5f + 15c2e36 commit df21642
Show file tree
Hide file tree
Showing 8 changed files with 28 additions and 28 deletions.
4 changes: 4 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
# MacOS
## Ignore desktop services files.
**/.DS_Store

# MkDocs
## Ignore site directory.
**/.site/**
4 changes: 2 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Release History

## v1.2.0 (Unreleased)
## [v1.2.0](https://github.com/vmware/powershell-module-for-vmware-cloud-foundation-power-management/releases/tag/v1.2.0)

> Release Date: Unreleased
> Release Date: 2023-07-25
Enhancement:

Expand Down
14 changes: 14 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
# WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
# COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
# OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

docs-install:
pip install mkdocs-material
pip install --requirement docs/requirements.txt
docs-serve:
mkdocs serve
docs-serve-live:
mkdocs serve --livereload -w ./
docs-build:
mkdocs build
4 changes: 2 additions & 2 deletions VMware.CloudFoundation.PowerManagement.psd1
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#
# Module manifest for module 'VMware.CloudFoundation.PowerManagement'
#
# Generated by: Gary Blake
# Generated by: VMware, Inc.
#
# Generated on: 2023-07-25
#
Expand All @@ -12,7 +12,7 @@
RootModule = 'VMware.CloudFoundation.PowerManagement.psm1'

# Version number of this module.
ModuleVersion = '1.2.0.1000'
ModuleVersion = '1.2.0.1001'

# Supported PSEditions
# CompatiblePSEditions = @()
Expand Down
13 changes: 5 additions & 8 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,14 +14,14 @@

The following table lists the supported platforms for this module.

Platform | Support
-------------------------------------------------------------|------------------------------------
:fontawesome-solid-cloud:   VMware Cloud Foundation 5.0.x on vSAN ReadyNodes | :fontawesome-solid-x:{ .red }
Platform | Support
----------------------------------------------------------------------------------|------------------------------------
:fontawesome-solid-cloud:   VMware Cloud Foundation 5.0.x on vSAN ReadyNodes | :fontawesome-solid-check:{ .green }
:fontawesome-solid-cloud:   VMware Cloud Foundation 4.5.x on vSAN ReadyNodes | :fontawesome-solid-check:{ .green }
:fontawesome-solid-cloud:   VMware Cloud Foundation 4.4.x on vSAN ReadyNodes | :fontawesome-solid-check:{ .green }
:fontawesome-solid-cloud:   VMware Cloud Foundation 4.3.x on vSAN ReadyNodes | :fontawesome-solid-check:{ .green }

!!! Note
!!! note

VMware Cloud Foundation on Dell EMC VxRail is not supported.

Expand Down Expand Up @@ -50,17 +50,14 @@ PowerShell Module | Version | Publisher
-----------------------------------------------------|-----------|--------------|---------------------------------------------------------------------------
[VMware.PowerCLI][psgallery-module-powercli] | >= 13.0.0 | VMware, Inc. | :fontawesome-solid-book:   [Documentation][developer-module-powercli]
[PowerVCF][psgallery-module-powervcf] | >= 2.3.0 | VMware, Inc. | :fontawesome-solid-book:   [Documentation][docs-module-powervcf]
[PowerValidatedSolutions][psgallery-module-pvs] | >= 2.4.0 | VMware, Inc. | :fontawesome-solid-book:   [Documentation][docs-module-pvs]
[PoshSSH][psgallery-module-poshssh] | >= 3.0.4 | darkoperator | :fontawesome-brands-github:   [GitHub][github-module-poshssh]
[PoshSSH][psgallery-module-poshssh] | >= 3.0.4 | Carlos Perez | :fontawesome-brands-github:   [GitHub][github-module-poshssh]

[docs-module-powervcf]: https://vmware.github.io/powershell-module-for-vmware-cloud-foundation
[docs-module-pvs]: https://vmware-samples.github.io/power-validated-solutions-for-cloud-foundation
[docs-vmware-cloud-foundation]: https://docs.vmware.com/en/VMware-Cloud-Foundation/index.html
[microsoft-powershell]: https://docs.microsoft.com/en-us/powershell
[psgallery-module-powercli]: https://www.powershellgallery.com/packages/VMware.PowerCLI
[psgallery-module-powervcf]: https://www.powershellgallery.com/packages/PowerVCF
[psgallery-module-power-management]: https://www.powershellgallery.com/packages/VMware.CloudFoundation.PowerManagement
[psgallery-module-pvs]: https://www.powershellgallery.com/packages/PowerValidatedSolutions
[psgallery-module-poshssh]: https://www.powershellgallery.com/packages/Posh-SSH
[developer-module-powercli]: https://developer.vmware.com/tool/vmware-powercli
[github-module-poshssh]: https://github.com/darkoperator/Posh-SSH
1 change: 0 additions & 1 deletion docs/snippets/import-module.ps1
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
Import-Module -Name VMware.PowerCLI
Import-Module -Name PowerVCF
Import-Module -Name PowerValidatedSolutions
Import-Module -Name Posh-SSH
Import-Module -Name VMware.CloudFoundation.PowerManagement
1 change: 0 additions & 1 deletion docs/snippets/update-modules.ps1
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
Update-Module -Name VMware.PowerCLI
Update-Module -Name PowerVCF
Update-Module -Name Posh-SSH
Update-Module -Name PowerValidatedSolutions
15 changes: 1 addition & 14 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,7 @@ repo_url: https://github.com/vmware/powershell-module-for-vmware-cloud-foundatio
edit_uri: blob/main/docs/

# Copyright
copyright: >
Copyright © 2023 - VMware, Inc. –
<a href="#__consent">Manage Settings</a>
copyright: Copyright &copy; 2023 - VMware, Inc.

# Configuration
theme:
Expand Down Expand Up @@ -84,17 +82,6 @@ extra:
config:
repo_url: https://github.com/vmware/powershell-module-for-vmware-cloud-foundation-power-management
repo_url_raw: https://raw.githubusercontent.com/vmware/powershell-module-for-vmware-cloud-foundation-power-management
consent:
title: Cookie Consent
description: >-
We use cookies to recognize your repeated visits and preferences, as well
as to measure the effectiveness of our documentation and whether users
find what they're searching for. With your consent, you're helping us to
make our documentation better.
actions:
- accept
- manage
- reject
version:
default: latest
provider: mike
Expand Down

0 comments on commit df21642

Please sign in to comment.