Simple repository for various PowerShell scripts

How to publish on PowerShell official gallery

All functions are now separated in multiple files. To simplify publishing all of them are simply combined in a single file to speedup loading and finally automatically published with the sample script publish.ps1.

To publish utility you can simply call

 .\publish.ps1 -version x.y.z -apiKey yourApiKeyHere

How to publish on PowerShell official gallery (old)

Please follow the instruction you find at official GitHub repository.

# Register local provider
Register-PSRepository `
    -Name Demo_build_utils `
    -SourceLocation  C:\develop\GitHub\powershell-build-utils\src\BuildUtils `
    -PublishLocation  C:\develop\GitHub\powershell-build-utils\src\BuildUtils `
    -InstallationPolicy Trusted 

# Publish module in local repository
Publish-Module `
    -Path C:\develop\github\powershell-build-utils\src\BuildUtils `
    -Repository Demo_build_utils ` 
    -NuGetApiKey your_key_here 

# Publish module to official gallery
Publish-Module `
    -Path C:\develop\github\powershell-build-utils\src\BuildUtils `
    -NuGetApiKey your_key_here `
    -Verbose 

How to manually use nuget.exe to publish (old)

If you want to publish packages in private repository

First step is register the feed where the package is published, as an example here is my public MyGet feed location. Be sure to use v2 version of feed, because at the time of this readme PowerShell works with v2 nuget package version

Register-PSRepository -Name MyGet -SourceLocation https://www.myget.org/F/alkampfer/api/v2

How to consume package from a repository (public or private)

You should be able to find this module with the following command

PS C:\somedir> Find-Module -Name BuildUtils

Version    Name                                Repository           Description
-------    ----                                ----------           -----------
0.x.x      BuildUtils                          PSGallery            Simple utilities to simplify build of .NET project

If everything is done correctly, we can install the module for the current user with this command (this will not require administrative permissions and install module for current user only)

Install-package BuildUtils -Confirm:$false -Force -Scope CurrentUser -Verbose

Once the package is installed successfully, you can import it and verify all the functions that are available for usage

PS C:\somedir> Import-Module BuildUtils
PS C:\somedir> Get-Command -module BuildUtils

CommandType     Name                                               Version    Source
-----------     ----                                               -------    ------
Function        Edit-XmlNodes                                      0.1.2      build-utils
Function        Get-7ZipLocation                                   0.1.2      build-utils
Function        Update-SourceVersion                               0.1.2      build-utils

You should be able now to simply use and manage those functions.

How to publish manually (if you want to add it to private gallery)

After you aligned version in .nuspec and .psd1 file, just run nuget to create package file. You can run following command in the src directory.

nuget.exe pack .\BuildUtils.nuspec

This will create a nuget package that can be pushed on a specific feed by this command

nuget.exe push build-utils.0.1.1.nupkg yourapikey -src https://www.myget.org/F/alkampfer/api/v3/index.json

To verify that the module is correct you can check for package correctness with the command

Test-ModuleManifest -Path .\BuildUtils.psd1

Some reminder on how to use modules

To verify if we have installed a specific function we can use the following command.

Get-Command Get-7ZipLocation

If you have the function installed on a specific module, you can always uninstall module (module name can be found with previous command)

Uninstall-Module -name build-utils -Force