Skip to content

Warning

You're viewing an older version of this GitHub Action. Do you want to see the latest version instead?

Setup PowerShell Toolkit

Actions
Setup PowerShell module hugoalh.GitHubActionsToolkit
v1.4.1
Star (3)

Tags

 (1)

Setup PowerShell Toolkit (GitHub Action)

License GitHub Repository GitHub Stars GitHub Contributors GitHub Issues GitHub Pull Requests GitHub Discussions CodeFactor Grade

Releases Latest (GitHub Latest Release Date) Pre (GitHub Latest Pre-Release Date)
GitHub GitHub Total Downloads GitHub Latest Release Version GitHub Latest Pre-Release Version

📝 Description

A GitHub Action to setup PowerShell module hugoalh.GitHubActionsToolkit (GitHub)(PowerShell Gallery).

📚 Documentation

⚠️ Important: This documentation is v1.4.0 based; To view other version's documentation, please visit the versions list and select the correct version.

Getting Started

  • GitHub Actions Runner >= v2.303.0
    • PowerShell >= v7.2.0
jobs:
  job_id:
    runs-on: "________" # Any
    steps:
      - uses: "hugoalh-studio/setup-powershell-toolkit-ghaction@<Version>"

📥 Input

version

[Optional] <String = "Latest"> Target version, by Semantic Versioning (SemVer) 2.0.0 with optional modifier; Default to the latest version.

  • Latest: Latest version
  • <Ma.Mi.Pa-PR+Bu: Less than version Ma.Mi.Pa-PR+Bu
  • <=Ma.Mi.Pa-PR+Bu: Less than or equal version Ma.Mi.Pa-PR+Bu
  • Ma.Mi.Pa-PR+Bu / =Ma.Mi.Pa-PR+Bu: Equal version Ma.Mi.Pa-PR+Bu
  • >=Ma.Mi.Pa-PR+Bu: Greater than or equal version Ma.Mi.Pa-PR+Bu
  • >Ma.Mi.Pa-PR+Bu: Greater than version Ma.Mi.Pa-PR+Bu
  • ^Ma.Mi.Pa-PR+Bu: Between version Ma.Mi.Pa-PR+Bu and major equitant latest version
  • ~Ma.Mi.Pa-PR+Bu: Between version Ma.Mi.Pa-PR+Bu and minor equitant latest version

allowprerelease

[Optional] <Boolean = False> Whether to allow target pre release version.

keepsetting

[Optional] <Boolean = True> Whether to keep the setting that modified by this action.

📤 Output

N/A

Example

jobs:
  job_id:
    name: "Hello World"
    runs-on: "ubuntu-latest"
    steps:
      - name: "Setup PowerShell Toolkit"
        uses: "hugoalh-studio/setup-powershell-toolkit-ghaction@v1.4.1"
      - run: |
          Import-Module -Name 'hugoalh.GitHubActionsToolkit' -Scope 'Local'
          Write-GitHubActionsNotice -Message 'Hello, world!'
        shell: "pwsh"

Guide

GitHub Actions

Setup PowerShell Toolkit is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.

About

Setup PowerShell module hugoalh.GitHubActionsToolkit
v1.4.1

Tags

 (1)

Setup PowerShell Toolkit is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.