Skip to content

Commit c606a51

Browse files
committed
Update readme
1 parent 9ae4cb8 commit c606a51

File tree

1 file changed

+49
-53
lines changed

1 file changed

+49
-53
lines changed

README.md

Lines changed: 49 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -10,51 +10,26 @@
1010

1111
A PowerShell module to provide a better and easier way for GitHub Actions to communicate with the runner machine, and the toolkit for developing GitHub Actions in PowerShell.
1212

13-
> **🔗 Other Edition:**
14-
>
15-
> - Go
16-
> - [actions-go/toolkit](https://github.com/actions-go/toolkit)
17-
> - [haya14busa/go-actions-toolkit](https://github.com/haya14busa/go-actions-toolkit)
18-
> - NodeJS
19-
> - [actions/toolkit](https://github.com/actions/toolkit) *\[Official\]*
20-
> - [@actions/artifact](https://www.npmjs.com/package/@actions/artifact)
21-
> - [@actions/cache](https://www.npmjs.com/package/@actions/cache)
22-
> - [@actions/core](https://www.npmjs.com/package/@actions/core)
23-
> - [@actions/exec](https://www.npmjs.com/package/@actions/exec)
24-
> - [@actions/github](https://www.npmjs.com/package/@actions/github)
25-
> - [@actions/glob](https://www.npmjs.com/package/@actions/glob)
26-
> - [@actions/http-client](https://www.npmjs.com/package/@actions/http-client)
27-
> - [@actions/io](https://www.npmjs.com/package/@actions/io)
28-
> - [@actions/tool-cache](https://www.npmjs.com/package/@actions/tool-cache)
29-
> - JasonEtco/actions-toolkit ([GitHub](https://github.com/JasonEtco/actions-toolkit))([NPM](https://www.npmjs.com/package/actions-toolkit))
30-
> - Python
31-
> - [boschglobal/action.toolkit](https://github.com/boschglobal/action.toolkit)
32-
33-
## 📓 Documentation (Excerpt)
34-
35-
For the full documentation, please visit the [GitHub Repository Wiki](https://github.com/hugoalh-studio/ghactions-toolkit-powershell/wiki).
36-
37-
### Getting Started
38-
39-
- GitHub Actions Runner >= v2.303.0
40-
- PowerShell >= v7.2.0
41-
- NodeJS >= v14.15.0 (only for NodeJS wrapper API)
13+
## 📥 Install
4214

43-
```ps1
44-
Install-Module -Name 'hugoalh.GitHubActionsToolkit' -AcceptLicense
45-
```
15+
### PowerShell
4616

47-
```ps1
48-
Import-Module -Name 'hugoalh.GitHubActionsToolkit' -Prefix 'GitHubActions' -Scope 'Local'
49-
```
17+
- **Target Version:** >= v7.2.0, &:
18+
- GitHub Actions Runner >= v2.303.0
19+
- NodeJS >= v14.15.0 (only for NodeJS wrapper API)
20+
- **Domain/Registry:**
21+
- **[PowerShell Gallery](https://www.powershellgallery.com/packages/hugoalh.GitHubActionsToolkit):**
22+
```ps1
23+
Install-Module -Name 'hugoalh.GitHubActionsToolkit' -AcceptLicense
24+
```
5025
51-
### API
26+
## 🧩 API (Excerpt)
5227
53-
> | **Legend** | **Description** |
54-
> |:-:|:--|
55-
> | 🔘 | **NodeJS Wrapper:** This dependents and requires NodeJS to invoke. |
28+
> **ℹ️ Notice:** Documentation is included inside the script file, can view it via:
29+
>
30+
> - [GitHub Repository Wiki](https://github.com/hugoalh-studio/ghactions-toolkit-powershell/wiki)
5631
57-
#### Function
32+
### Function
5833
5934
- `Add-GitHubActionsPATH`
6035
- `Add-GitHubActionsProblemMatcher`
@@ -71,23 +46,23 @@ Import-Module -Name 'hugoalh.GitHubActionsToolkit' -Prefix 'GitHubActions' -Scop
7146
- `Enable-GitHubActionsStdOutCommandProcess`
7247
- `Enter-GitHubActionsLogGroup`
7348
- `Exit-GitHubActionsLogGroup`
74-
- `Expand-GitHubActionsToolCacheCompressedFile` 🔘
75-
- `Export-GitHubActionsArtifact` 🔘
76-
- `Find-GitHubActionsToolCache` 🔘
49+
- `Expand-GitHubActionsToolCacheCompressedFile`
50+
- `Export-GitHubActionsArtifact`
51+
- `Find-GitHubActionsToolCache`
7752
- `Get-GitHubActionsDebugStatus`
7853
- `Get-GitHubActionsInput`
79-
- `Get-GitHubActionsOpenIdConnectToken` 🔘
54+
- `Get-GitHubActionsOpenIdConnectToken`
8055
- `Get-GitHubActionsState`
8156
- `Get-GitHubActionsStepSummary`
8257
- `Get-GitHubActionsWebhookEventPayload`
8358
- `Get-GitHubActionsWorkflowRunUri`
84-
- `Import-GitHubActionsArtifact` 🔘
85-
- `Invoke-GitHubActionsToolCacheToolDownloader` 🔘
86-
- `Register-GitHubActionsToolCacheDirectory` 🔘
87-
- `Register-GitHubActionsToolCacheFile` 🔘
59+
- `Import-GitHubActionsArtifact`
60+
- `Invoke-GitHubActionsToolCacheToolDownloader`
61+
- `Register-GitHubActionsToolCacheDirectory`
62+
- `Register-GitHubActionsToolCacheFile`
8863
- `Remove-GitHubActionsProblemMatcher`
89-
- `Restore-GitHubActionsCache` 🔘
90-
- `Save-GitHubActionsCache` 🔘
64+
- `Restore-GitHubActionsCache`
65+
- `Save-GitHubActionsCache`
9166
- `Set-GitHubActionsEnvironmentVariable`
9267
- `Set-GitHubActionsOutput`
9368
- `Set-GitHubActionsState`
@@ -102,11 +77,32 @@ Import-Module -Name 'hugoalh.GitHubActionsToolkit' -Prefix 'GitHubActions' -Scop
10277
- `Write-GitHubActionsRaw`
10378
- `Write-GitHubActionsWarning`
10479
105-
### Example
80+
## ✍️ Example
10681
10782
- ```ps1
83+
Import-Module -Name 'hugoalh.GitHubActionsToolkit' -Scope 'Local'
84+
10885
Set-GitHubActionsOutput -Name 'foo' -Value 'bar'
109-
```
110-
- ```ps1
86+
11187
Write-GitHubActionNotice -Message 'Hello, world!'
11288
```
89+
90+
## 🔗 Other Edition
91+
92+
- Go
93+
- [actions-go/toolkit](https://github.com/actions-go/toolkit)
94+
- [haya14busa/go-actions-toolkit](https://github.com/haya14busa/go-actions-toolkit)
95+
- NodeJS
96+
- [actions/toolkit](https://github.com/actions/toolkit) *\[Official\]*
97+
- [@actions/artifact](https://www.npmjs.com/package/@actions/artifact)
98+
- [@actions/cache](https://www.npmjs.com/package/@actions/cache)
99+
- [@actions/core](https://www.npmjs.com/package/@actions/core)
100+
- [@actions/exec](https://www.npmjs.com/package/@actions/exec)
101+
- [@actions/github](https://www.npmjs.com/package/@actions/github)
102+
- [@actions/glob](https://www.npmjs.com/package/@actions/glob)
103+
- [@actions/http-client](https://www.npmjs.com/package/@actions/http-client)
104+
- [@actions/io](https://www.npmjs.com/package/@actions/io)
105+
- [@actions/tool-cache](https://www.npmjs.com/package/@actions/tool-cache)
106+
- JasonEtco/actions-toolkit ([GitHub](https://github.com/JasonEtco/actions-toolkit))([NPM](https://www.npmjs.com/package/actions-toolkit))
107+
- Python
108+
- [boschglobal/action.toolkit](https://github.com/boschglobal/action.toolkit)

0 commit comments

Comments
 (0)