10
10
11
11
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.
12
12
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
42
14
43
- ``` ps1
44
- Install-Module -Name 'hugoalh.GitHubActionsToolkit' -AcceptLicense
45
- ```
15
+ ### PowerShell
46
16
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
+ ```
50
25
51
- ### API
26
+ ## 🧩 API (Excerpt)
52
27
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)
56
31
57
- #### Function
32
+ ### Function
58
33
59
34
- `Add-GitHubActionsPATH`
60
35
- `Add-GitHubActionsProblemMatcher`
@@ -71,23 +46,23 @@ Import-Module -Name 'hugoalh.GitHubActionsToolkit' -Prefix 'GitHubActions' -Scop
71
46
- `Enable-GitHubActionsStdOutCommandProcess`
72
47
- `Enter-GitHubActionsLogGroup`
73
48
- `Exit-GitHubActionsLogGroup`
74
- - ` Expand-GitHubActionsToolCacheCompressedFile ` 🔘
75
- - ` Export-GitHubActionsArtifact ` 🔘
76
- - ` Find-GitHubActionsToolCache ` 🔘
49
+ - `Expand-GitHubActionsToolCacheCompressedFile`
50
+ - `Export-GitHubActionsArtifact`
51
+ - `Find-GitHubActionsToolCache`
77
52
- `Get-GitHubActionsDebugStatus`
78
53
- `Get-GitHubActionsInput`
79
- - ` Get-GitHubActionsOpenIdConnectToken ` 🔘
54
+ - `Get-GitHubActionsOpenIdConnectToken`
80
55
- `Get-GitHubActionsState`
81
56
- `Get-GitHubActionsStepSummary`
82
57
- `Get-GitHubActionsWebhookEventPayload`
83
58
- `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`
88
63
- `Remove-GitHubActionsProblemMatcher`
89
- - ` Restore-GitHubActionsCache ` 🔘
90
- - ` Save-GitHubActionsCache ` 🔘
64
+ - `Restore-GitHubActionsCache`
65
+ - `Save-GitHubActionsCache`
91
66
- `Set-GitHubActionsEnvironmentVariable`
92
67
- `Set-GitHubActionsOutput`
93
68
- `Set-GitHubActionsState`
@@ -102,11 +77,32 @@ Import-Module -Name 'hugoalh.GitHubActionsToolkit' -Prefix 'GitHubActions' -Scop
102
77
- `Write-GitHubActionsRaw`
103
78
- `Write-GitHubActionsWarning`
104
79
105
- ### Example
80
+ ## ✍️ Example
106
81
107
82
- ```ps1
83
+ Import-Module -Name 'hugoalh.GitHubActionsToolkit' -Scope 'Local'
84
+
108
85
Set-GitHubActionsOutput -Name 'foo' -Value 'bar'
109
- ```
110
- - ``` ps1
86
+
111
87
Write-GitHubActionNotice -Message 'Hello, world!'
112
88
```
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