hjorslev / TemplatePowerShellModule

A Template PowerShell Module

TemplatePowerShellModule

Module Status

TemplatePowerShellModule Title

{Super High level description}

Synopsis

A PowerShell Module to

Description

A PowerShell Module to

Using TemplatePowerShellModule

This is a template PowerShell module that includes a pipeline that builds the module (documentation etc.), commits documentation and external help to GitHub and deploys the module to the PowerShell Gallery.

Change variables

Change all mentions of ModuleName to the name of your module, e.g. SteamPS.

Change the name in LICENSE.md if you plan using it.

Adjust Manifest.

Building with AppVeyor and deploy to PS Gallery

AppVeyor is free for open source projects.

1. Create an account etc. at AppVeyor
2. Link your GitHub account
3. Create new project at AppVeyor
4. Create API-key at PS Gallery
5. Encrypt API-key at AppVeyor and add it to appveyor.yml by replacing {NUGETAPIKEY}.
6. Create Personal access tokens at GitHub with scope to edit repos.
7. Encrypt token at AppVeyor and add it to appveyor.yml by replacing {GITHUB_PERSONAL_ACCESS_TOKEN}.
8. AppVeyor will now monitor your branches.
9. Deploy to PS Gallery and GitHub releases using keyword !deploy in your commit message.

Change version

Patch version is changed when merging with master branch.

Major version can be changed by writing !ver:MAJOR* in the commit message.

Minor version can be changed by writing !ver:MINOR* in the commit message.