Brownserve.PSTools.psd1

#
# Module manifest for module 'Brownserve.PSTools'
#
# Generated by: Brownserve UK
#
# Generated on: 6/4/2023
#

@{

# Script module or binary module file associated with this manifest.
RootModule = 'Brownserve.PSTools.psm1'

# Version number of this module.
ModuleVersion = '0.12.0'

# Supported PSEditions
# CompatiblePSEditions = @()

# ID used to uniquely identify this module
GUID = '44b45ef7-6e06-4d07-901a-210b8df05b96'

# Author of this module
Author = 'Brownserve UK'

# Company or vendor of this module
CompanyName = 'Brownserve UK'

# Copyright statement for this module
Copyright = '2023 Brownserve UK'

# Description of the functionality provided by this module
Description = 'A collection of common tools for use in Brownserve projects'

# Minimum version of the PowerShell engine required by this module
PowerShellVersion = '6.0'

# Name of the PowerShell host required by this module
# PowerShellHostName = ''

# Minimum version of the PowerShell host required by this module
# PowerShellHostVersion = ''

# Minimum version of Microsoft .NET Framework required by this module. This prerequisite is valid for the PowerShell Desktop edition only.
# DotNetFrameworkVersion = ''

# Minimum version of the common language runtime (CLR) required by this module. This prerequisite is valid for the PowerShell Desktop edition only.
# ClrVersion = ''

# Processor architecture (None, X86, Amd64) required by this module
# ProcessorArchitecture = ''

# Modules that must be imported into the global environment prior to importing this module
# RequiredModules = @()

# Assemblies that must be loaded prior to importing this module
# RequiredAssemblies = @()

# Script files (.ps1) that are run in the caller's environment prior to importing this module.
# ScriptsToProcess = @()

# Type files (.ps1xml) to be loaded when importing this module
# TypesToProcess = @()

# Format files (.ps1xml) to be loaded when importing this module
# FormatsToProcess = @()

# Modules to import as nested modules of the module specified in RootModule/ModuleToProcess
# NestedModules = @()

# Functions to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no functions to export.
FunctionsToExport = 'Add-ChangelogEntry', 'Get-SPDXLicenseIDs', 
               'Initialize-BrownserveRepository', 
               'New-BrownservePowerShellModuleBuild', 'New-NuGetPackageVersion', 
               'Read-Changelog', 'Send-BuildNotification', 
               'Update-BrownserveRepository', 'Update-Changelog', 
               'Install-ChocolateyPackage', 'Assert-Command', 'Assert-Directory', 
               'ConvertTo-SortedHashtable', 'Get-Response', 'Invoke-DownloadMethod', 
               'Invoke-NativeCommand', 'Merge-Hashtable', 
               'New-BrownserveTemporaryDirectory', 'New-BrownserveTemporaryFile', 
               'Read-ConfigurationFromFile', 'Search-FileContent', 
               'Test-Administrator', 'Test-OperatingSystem', 'Add-ModuleHelp', 
               'Build-ModuleDocumentation', 'ConvertTo-HTTPSRepoURL', 
               'Get-GitBranches', 'Get-GitCurrentBranch', 'Get-GitRemoteOriginURL', 
               'New-GitBranch', 'Switch-GitBranch', 'Add-PullRequestComment', 
               'Get-GitHubRelease', 'Get-GitHubTags', 'Get-OpenPullRequests', 
               'New-GitHubRelease', 'New-PullRequest', 
               'New-BrownservePowerShellModule', 
               'Update-BrownservePowerShellModule', 'Send-SlackNotification', 
               'Publish-TeamcityArtifact', 'Set-TeamcityBuildNumber', 
               'Write-TeamcityBuildProblem', 'Write-TeamcityStatus', 
               'Format-TerraformResourceName', 'Get-Terraform', 
               'Get-TerraformResource', 'Invoke-TerraformApply', 
               'Invoke-TerraformInit', 'Invoke-TerraformPlan', 
               'Invoke-TerraformShow', 'Invoke-TerraformValidate', 
               'New-TerraformResourceBlock', 'Set-TerraformLogLevel', 'Get-Vault', 
               'Get-VaultSecret', 'Split-URI'

# Cmdlets to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no cmdlets to export.
CmdletsToExport = '*'

# Variables to export from this module
VariablesToExport = '*'

# Aliases to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no aliases to export.
AliasesToExport = '*'

# DSC resources to export from this module
# DscResourcesToExport = @()

# List of all modules packaged with this module
# ModuleList = @()

# List of all files packaged with this module
# FileList = @()

# 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 = 'CI', 'CD', 'Brownserve-UK'

        # A URL to the license for this module.
        LicenseUri = 'https://github.com/Brownserve-UK/Brownserve.PSTools/blob/main/LICENSE'

        # A URL to the main website for this project.
        ProjectUri = 'https://github.com/Brownserve-UK/Brownserve.PSTools'

        # A URL to an icon representing this module.
        # IconUri = ''

        # ReleaseNotes of this module
        ReleaseNotes = '
Features
Cmdlet updates/additions:
- Various new classes for handling data types
- Initialize-BrownserveRepository cmdlet which replaces the previous Initialize-BrownserveBuildRepo cmdlet
- New-BrownservePowerShellModuleBuild which allows for the quick creation of builds in repos.
- Assert-Command ensures a command is present in the current session
- ConvertTo-SortedHashtable converts a hashtable to one which is ordered alphabetically
- Tweak Invoke-NativeCommand to return the exit code
- Merge-Hashtable merges two hashtables together
- New-BrownserveTemporaryDirectory replaces New-BrownserveTempDirectory to be more consistent with our naming
- Read-ConfigurationFromFile allows storing complex default data in .json files
- Search-FileContent searches a file and returns any text between the two indicators
- Rework our help generation cmdlets to actually work
- ConvertTo-HTTPSRepoURL converts a ssh git repo URI to the HTTPS equivalent
- Various cmdlets for working with git
- Rename ConvertFrom-URI to Split-URI
Build/Test features:
- Updates the build/test scripts to use our new standard approach
- Updates the repo to be compatible with our new automated init/update approach
- Removed private cmdlet documentation, these will now be documented in the cmdlets themselves if required
 
 
Bugfixes
N/A
 
Known Issues
- This release renames a lot of our previously used cmdlets
- Private cmdlet documentation has been removed
'


        # Prerelease string of this module
        # Prerelease = ''

        # Flag to indicate whether the module requires explicit user acceptance for install/update/save
        # RequireLicenseAcceptance = $false

        # External dependent modules of this module
        # ExternalModuleDependencies = @()

    } # End of PSData hashtable

} # End of PrivateData hashtable

# HelpInfo URI of this module
# HelpInfoURI = ''

# Default prefix for commands exported from this module. Override the default prefix using Import-Module -Prefix.
# DefaultCommandPrefix = ''

}