Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hugoalh/github-actions-core-powershell
A PowerShell module to provide a better and easier way for GitHub Actions to communicate with the runner, and the toolkit for developing GitHub Actions.
https://github.com/hugoalh/github-actions-core-powershell
core gh-actions ghactions github-actions powershell toolkit
Last synced: about 2 months ago
JSON representation
A PowerShell module to provide a better and easier way for GitHub Actions to communicate with the runner, and the toolkit for developing GitHub Actions.
- Host: GitHub
- URL: https://github.com/hugoalh/github-actions-core-powershell
- Owner: hugoalh
- License: other
- Created: 2021-12-21T05:07:16.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-11-18T10:06:59.000Z (2 months ago)
- Last Synced: 2024-11-18T11:27:37.945Z (2 months ago)
- Topics: core, gh-actions, ghactions, github-actions, powershell, toolkit
- Language: PowerShell
- Homepage:
- Size: 5.14 MB
- Stars: 5
- Watchers: 2
- Forks: 1
- 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
# GitHub Actions - Core (PowerShell)
> [!IMPORTANT]
> - This project is transferred ownership from hugoalh Studio (`hugoalh-studio`) to hugoalh (`hugoalh`) and refactoring, some of the files may not modified/updated yet.
> - Looking the source code of the old PowerShell module `hugoalh.GitHubActionsToolkit`? Please visit the [versions list](https://github.com/hugoalh/github-actions-core-powershell/tags) and select the correct version.
[**⚖️** MIT](./LICENSE.md)
[](https://github.com/hugoalh/github-actions-core-powershell)
[](https://www.powershellgallery.com/packages/hugoalh.GitHubActionsCore)
A PowerShell module to provide a better and easier way for GitHub Actions to communicate with the runner, and the toolkit for developing GitHub Actions.
## ⚠️ Important
[official-toolkit]: https://github.com/actions/toolkit
This is a partial refactor of [the official toolkit][official-toolkit], not all of the features in [the official toolkit][official-toolkit] are available in here, and not all of the features in here are available in [the official toolkit][official-toolkit].
## 🌟 Features
- Ability to use directly on GitHub Actions with PowerShell runtime without complex setup.
## 🔰 Begin
### 🎯 Targets
| | **PowerShell Gallery** |
|:--|:--|
| **[PowerShell](https://microsoft.com/PowerShell)** >= v7.2.0 | ✔️ |
> [!NOTE]
> - It is possible to use this module in other methods/ways which not listed in here, however those methods/ways are not officially supported, and should beware maybe cause security issues.
### #️⃣ Resources Identifier
- **PowerShell Gallery:**
```
hugoalh.GitHubActionsCore
```
## 🧩 APIs
**Default Prefix:** `GitHubActions`
- `Add-PATH`
- `Add-ProblemMatcher`
- `Add-SecretMask`
- `Add-Summary`
- `Disable-StdOutCommandEcho`
- `Disable-StdOutCommandProcess`
- `Enable-StdOutCommandEcho`
- `Enable-StdOutCommandProcess`
- `Enter-LogGroup`
- `Exit-LogGroup`
- `Get-DebugStatus`
- `Get-Input`
- `Get-State`
- `Get-WebhookEventPayload`
- `Get-WorkflowRunUri`
- `Remove-ProblemMatcher`
- `Set-EnvironmentVariable`
- `Set-Output`
- `Set-State`
- `Set-Summary`
- `Test-Environment`
- `Write-Debug`
- `Write-Error`
- `Write-Fail`
- `Write-Notice`
- `Write-Warning`
> [!NOTE]
> - For the full or prettier documentation, can visit via:
> - [GitHub Repository Wiki](https://github.com/hugoalh/github-actions-core-powershell/wiki)
## ✍️ Examples
- ```ps1
Set-Output -Name 'foo' -Value 'bar'
```
- ```ps1
Write-GitHubActionsNotice -Message 'Hello, world!'
```