/ShPwsh

Primary LanguagePowerShell

ShPwsh

Tools for interacting with shell commands in a PowerShell-y way

Getting Started

  1. Installation process

    Access to the repository required:

    ```
$repo = 'PsGallery' # Private internal repo is preferred
Install-Module -Name ShPwsh -Repository $repo
```

    Without Repository available, clone directly from Git:

    ```
$uri = 'f'.Trim()
$ModuleParent = $env:PSModulePath -split ';' | Where {$_ -like "*$($env:USERNAME)*"} | Select -First 1
Set-Location $ModuleParent
git clone $uri
```

  1. Dependencies

    This module has the following PowerShell Dependancies:

    None

    This module has the following Software Dependancies:

    This module has no dependancies other than a supported Windows OS.

  1. Version History

    • v0.1.0.1 - Initial Commit.

Build, Test, and Publish

  1. Pester test.

  2. Get next version number v#.#.#.# and a comment [string] for the change log.

  3. Create a new Package folder as .\Package\v#.#.#.#\

  4. Copy the PSD1 files in as-is.

    Update the version number and copyright date if required.

    Update the Exported Function Name array with the basenames of the files under the Public folder only.

  5. Create a new, blank PSM1 file in here.

    Populate it with all of the PS1 files' content from the .\Public and .\Private folders.

  6. Create a NUSPEC file and update the version and change log.

  7. Build the NuGet package.

  8. Push to private repo.


Contribute

How to help make this module better:

  1. Add your changes to a new feature sub-branch.

  2. Add Pester tests for your changes.

  3. Push your branch to origin.

  4. Submit a PR with description of changes.

  5. Follow up in 1 business day.