chore: Add additional metadata to PowerShell Gallery listing
Closed this issue · 1 comments
tenthirtyam commented
Code of Conduct
- I have read and agree to the project's Code of Conduct.
Description
List the following alongside the module in the PowerShell Gallery:
- License: GitHub link to the
LICENSE
. - Release Notes: Ghthub link to
CHAGNELOG.md
) - Icon: Link to a
.svg
image for the project. - Project: GitHub link to the project.
Use Case(s)
Enhance metadata provided to a user when visiting the PowerShell Gallery.
Potential Configuration
Example additions to the PowerVCF.psd1
file:
# 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 = @{
# Tags applied to this module. These help with module discovery in online galleries.
Tags = @('VMware', 'Cloud Foundation', 'VMware Cloud Foundation')
# A URL to the license for this module.
LicenseUri = 'https://github.com/vmware/powershell-module-for-vmware-cloud-foundation/blob/main/LICENSE'
# A URL to the main website for this project.
ProjectUri = 'https://github.com/vmware/powershell-module-for-vmware-cloud-foundation'
# A URL to an icon representing this module.
IconUri = 'https://raw.githubusercontent.com/vmware/powershell-module-for-vmware-cloud-foundation/main/.github/icon-85px.svg'
# ReleaseNotes of this module
ReleaseNotes = 'https://github.com/vmware/powershell-module-for-vmware-cloud-foundation/blob/main/CHANGELOG.md'
} # End of PSData hashtable
} # End of PrivateData hashtable
References
No response
github-actions commented
'I'm going to lock this issue because it has been closed for 30 days. This helps our maintainers find and focus on the active issues.
If you have found a problem that seems similar to this, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.'