Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hugoalh-studio/setup-powershell-toolkit-ghaction
A GitHub Action to setup PowerShell module `hugoalh.GitHubActionsToolkit`.
https://github.com/hugoalh-studio/setup-powershell-toolkit-ghaction
gh-action ghaction github-action powershell setup
Last synced: about 1 month ago
JSON representation
A GitHub Action to setup PowerShell module `hugoalh.GitHubActionsToolkit`.
- Host: GitHub
- URL: https://github.com/hugoalh-studio/setup-powershell-toolkit-ghaction
- Owner: hugoalh-studio
- License: other
- Created: 2023-03-08T04:24:14.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-10-20T00:36:11.000Z (2 months ago)
- Last Synced: 2024-11-16T09:34:40.322Z (about 1 month ago)
- Topics: gh-action, ghaction, github-action, powershell, setup
- Language: PowerShell
- Homepage:
- Size: 104 KB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
- Citation: CITATION.cff
- Codeowners: .github/CODEOWNERS
- Security: SECURITY.md
Awesome Lists containing this project
README
# Setup PowerShell Toolkit (GitHub Action)
[**⚖️** MIT](./LICENSE.md)
**🗂️**
[](https://github.com/hugoalh-studio/setup-powershell-toolkit-ghaction)
**🆙**  ()
A GitHub Action to setup PowerShell module `hugoalh.GitHubActionsToolkit` ([GitHub](https://github.com/hugoalh-studio/ghactions-toolkit-powershell))([PowerShell Gallery](https://www.powershellgallery.com/packages/hugoalh.GitHubActionsToolkit)).
> [!IMPORTANT]
> This documentation is v2.0.0 based; To view other version's documentation, please visit the [versions list](https://github.com/hugoalh-studio/setup-powershell-toolkit-ghaction/tags) and select the correct version.
## 🎯 Target
- GitHub Actions Runner
> **🛡️ Require Permission**
>
> *N/A*
> **💽 Require Software**
>
> - PowerShell >= v7.2.0
## 🔰 Usage
### Composite Action
1. Import at the metadata (`action.yml`):
```yml
runs:
using: "composite"
steps:
- uses: "hugoalh-studio/setup-powershell-toolkit-ghaction@"
```
### Workflow
1. Import at the workflow (`.github/workflows/.yml`):
```yml
jobs:
job_id:
runs-on: "________" # Any
steps:
- uses: "hugoalh-studio/setup-powershell-toolkit-ghaction@"
```
## 🧩 Input
> [!NOTE]
> All of the inputs are optional; Use this action without any input will default to install major equitant latest version of `2.1.0` for current user, and keep the setting that modified.
### `sudo`
`` Whether to execute in sudo mode on non-Windows environment. This must set to `True` in order to able install for all users on non-Windows environment (i.e.: when [input `scope`](#scope) is `"AllUsers"`).
### `version`
`` Target version, by [Semantic Versioning (SemVer) 2.0.0](https://semver.org/spec/v2.0.0.html) with optional modifier; Default to major equitant latest version of `2.1.0`.
- **`"Latest"`:** Latest version
- **`"<1.2.3"`:** Less than this version
- **`"<=1.2.3"`:** Less than or equal to this version
- **`"1.2.3"` / `"=1.2.3"`:** Equal to this version
- **`">=1.2.3"`:** Greater than or equal to this version
- **`">1.2.3"`:** Greater than this version
- **`"^1.2.3"`:** Between this version and major equitant latest version
- **`"~1.2.3"`:** Between this version and minor equitant latest version
### `allowprerelease`
`` Whether to allow target pre release version.
### `scope`
`` Installation scope.
- **`"AllUsers"`:** For all users. Also need to set [input `sudo`](#sudo) to `True` on non-Windows environment.
- **`"CurrentUser"`:** For current user.
### `force`
`` Whether to force install or reinstall target (pre release) version.
### `keepsetting`
`` Whether to keep the setting that modified.
## 🧩 Output
### `path`
`` Path of the installation.
### `version`
`` Version of the installation.
## ✍️ Example
- ```yml
jobs:
job_id:
name: "Hello World"
runs-on: "ubuntu-latest"
steps:
- name: "Setup PowerShell Toolkit"
uses: "hugoalh-studio/[email protected]"
- run: |
Import-Module -Name 'hugoalh.GitHubActionsToolkit' -Scope 'Local'
Write-GitHubActionsNotice -Message 'Hello, world!'
shell: "pwsh"
```
## 📚 Guide
- GitHub Actions
- [Enabling debug logging](https://docs.github.com/en/actions/monitoring-and-troubleshooting-workflows/enabling-debug-logging)