@@ -29,6 +29,8 @@ A PowerShell module to provide a better and easier way for GitHub Actions to com
29
29
#### Install
30
30
31
31
- PowerShell >= v7.2.0
32
+ - NodeJS >= v14.15.0 (only for NodeJS wrapper API)
33
+ - NPM >= v6.14.8 (only for NodeJS wrapper API)
32
34
33
35
``` ps1
34
36
Install-Module -Name 'hugoalh.GitHubActionsToolkit' -AcceptLicense
@@ -44,6 +46,11 @@ Import-Module -Name 'hugoalh.GitHubActionsToolkit' -Prefix 'GitHubActions' -Scop
44
46
45
47
### API (Excerpt)
46
48
49
+ | ** Legend** | ** Description** |
50
+ | :-:| :--|
51
+ | 🧪 | ** Experimental:** Experimental API. |
52
+ | 🔘 | ** NodeJS Wrapper:** Wrapper API, require NodeJS as dependency. |
53
+
47
54
#### Function
48
55
49
56
- ` Add-GitHubActionsPATH `
@@ -61,24 +68,24 @@ Import-Module -Name 'hugoalh.GitHubActionsToolkit' -Prefix 'GitHubActions' -Scop
61
68
- ` Enable-GitHubActionsProcessingCommands `
62
69
- ` Enter-GitHubActionsLogGroup `
63
70
- ` Exit-GitHubActionsLogGroup `
64
- - ` Expand-GitHubActionsToolCacheCompressedFile ` 🧪
65
- - ` Export-GitHubActionsArtifact ` 🧪
66
- - ` Find-GitHubActionsToolCache ` 🧪
71
+ - ` Expand-GitHubActionsToolCacheCompressedFile ` 🧪🔘
72
+ - ` Export-GitHubActionsArtifact ` 🧪🔘
73
+ - ` Find-GitHubActionsToolCache ` 🧪🔘
67
74
- ` Get-GitHubActionsInput `
68
75
- ` Get-GitHubActionsIsDebug `
69
76
- ` Get-GitHubActionsOpenIdConnectToken ` 🧪
70
77
- ` Get-GitHubActionsState `
71
78
- ` Get-GitHubActionsStepSummary `
72
79
- ` Get-GitHubActionsWebhookEventPayload `
73
80
- ` Get-GitHubActionsWorkflowRunUri `
74
- - ` Import-GitHubActionsArtifact ` 🧪
75
- - ` Invoke-GitHubActionsToolCacheToolDownloader ` 🧪
76
- - ` Register-GitHubActionsToolCacheDirectory ` 🧪
77
- - ` Register-GitHubActionsToolCacheFile ` 🧪
81
+ - ` Import-GitHubActionsArtifact ` 🧪🔘
82
+ - ` Invoke-GitHubActionsToolCacheToolDownloader ` 🧪🔘
83
+ - ` Register-GitHubActionsToolCacheDirectory ` 🧪🔘
84
+ - ` Register-GitHubActionsToolCacheFile ` 🧪🔘
78
85
- ` Remove-GitHubActionsProblemMatcher `
79
86
- ` Remove-GitHubActionsStepSummary `
80
- - ` Restore-GitHubActionsCache ` 🧪
81
- - ` Save-GitHubActionsCache ` 🧪
87
+ - ` Restore-GitHubActionsCache ` 🧪🔘
88
+ - ` Save-GitHubActionsCache ` 🧪🔘
82
89
- ` Set-GitHubActionsEnvironmentVariable `
83
90
- ` Set-GitHubActionsOutput `
84
91
- ` Set-GitHubActionsState `
0 commit comments