Skip to content

Latest commit

 

History

History
47 lines (27 loc) · 1.98 KB

README.md

File metadata and controls

47 lines (27 loc) · 1.98 KB

psdocker

.github/workflows/build-validation.yml

Installation

Make sure that the docker cli is installed. e.g. from Chocolatey or with Docker Desktop.

Install psdocker from PowerShell Gallery using a PowerShell command line:

Install-Module -Name psdocker -Scope CurrentUser

Build

This project uses a build script that is based on Invoke-Build. For installation details see the instructions from the Invoke-Build project, but we recommend Install-Module InvokeBuild -Scope CurrentUser. The documentation is based on platyPS, so you may want to execute Install-Module PlatyPs -Scope CurrentUser.

You can run the build by:

  • PowerShell: execute Invoke-Build in a PowerShell in the directory of this project
  • VSCode: run the integrated build task feature (F1 + "Tasks: Run Build Task")

Test

This project uses test scripts using Pester. For installation details see the instructions from the Pester project, but we recommend Install-Module Pester -Scope CurrentUser.

You can run the tests by:

  • PowerShell: execute Invoke-Build Test in a PowerShell in the directory of this project
  • VSCode: run the integrated test task feature (F1 + "Tasks: Run Test Task")

For debugging tests change the working directory to ./src/test create the breakpoint in VSCode and start debugging by F1 + "Debug: Start Debugging".

Usage

See the folder docs for examples.

Changelog

See the changelog file.

Contributors

  • Steffen Kampmann
  • Marc Kassay