@@ -19,7 +19,7 @@ The GitHub Actions ToolKit provides a set of packages to make creating actions e
19
19
20
20
## Packages
21
21
22
- :heavy_check_mark : [ @actions/core ] ( packages/core )
22
+ :heavy_check_mark : [ @actions/core ] ( packages/core )
23
23
24
24
Provides functions for inputs, outputs, results, logging, secrets and variables. Read more [ here] ( packages/core )
25
25
@@ -28,7 +28,7 @@ $ npm install @actions/core
28
28
```
29
29
<br />
30
30
31
- :runner : [ @actions/exec ] ( packages/exec )
31
+ :runner : [ @actions/exec ] ( packages/exec )
32
32
33
33
Provides functions to exec cli tools and process output. Read more [ here] ( packages/exec )
34
34
@@ -46,7 +46,7 @@ $ npm install @actions/glob
46
46
```
47
47
<br />
48
48
49
- :pencil2 : [ @actions/io ] ( packages/io )
49
+ :pencil2 : [ @actions/io ] ( packages/io )
50
50
51
51
Provides disk i/o functions like cp, mv, rmRF, find etc. Read more [ here] ( packages/io )
52
52
@@ -55,18 +55,18 @@ $ npm install @actions/io
55
55
```
56
56
<br />
57
57
58
- :hammer : [ @actions/tool-cache ] ( packages/tool-cache )
58
+ :hammer : [ @actions/tool-cache ] ( packages/tool-cache )
59
59
60
60
Provides functions for downloading and caching tools. e.g. setup-* actions. Read more [ here] ( packages/tool-cache )
61
61
62
- See @actions/cache for caching workflow dependencies.
62
+ See @actions/cache for caching workflow dependencies.
63
63
64
64
``` bash
65
65
$ npm install @actions/tool-cache
66
66
```
67
67
<br />
68
68
69
- :octocat: [ @actions/github ] ( packages/github )
69
+ :octocat: [ @actions/github ] ( packages/github )
70
70
71
71
Provides an Octokit client hydrated with the context that the current action is being run in. Read more [ here] ( packages/github )
72
72
@@ -75,7 +75,7 @@ $ npm install @actions/github
75
75
```
76
76
<br />
77
77
78
- :floppy_disk : [ @actions/artifact ] ( packages/artifact )
78
+ :floppy_disk : [ @actions/artifact ] ( packages/artifact )
79
79
80
80
Provides functions to interact with actions artifacts. Read more [ here] ( packages/artifact )
81
81
@@ -84,7 +84,7 @@ $ npm install @actions/artifact
84
84
```
85
85
<br />
86
86
87
- :dart : [ @actions/cache ] ( packages/cache )
87
+ :dart : [ @actions/cache ] ( packages/cache )
88
88
89
89
Provides functions to cache dependencies and build outputs to improve workflow execution time. Read more [ here] ( packages/cache )
90
90
@@ -115,7 +115,7 @@ Problem Matchers are a way to scan the output of actions for a specified regex p
115
115
116
116
:warning : [ Proxy Server Support] ( docs/proxy-support.md )
117
117
118
- Self-hosted runners can be configured to run behind proxy servers.
118
+ Self-hosted runners can be configured to run behind proxy servers.
119
119
<br />
120
120
<br />
121
121
@@ -132,23 +132,23 @@ Illustrates how to create a simple hello world javascript action.
132
132
<br />
133
133
134
134
<h3 ><a href =" https://github.com/actions/javascript-action " >JavaScript Action Walkthrough</a ></h3 >
135
-
135
+
136
136
Walkthrough and template for creating a JavaScript Action with tests, linting, workflow, publishing, and versioning.
137
137
138
138
``` javascript
139
139
async function run () {
140
- try {
140
+ try {
141
141
const ms = core .getInput (' milliseconds' );
142
142
console .log (` Waiting ${ ms} milliseconds ...` )
143
143
...
144
144
` ` `
145
145
` ` ` javascript
146
146
PASS ./ index .test .js
147
- ✓ throws invalid number
148
- ✓ wait 500 ms
147
+ ✓ throws invalid number
148
+ ✓ wait 500 ms
149
149
✓ test runs
150
150
151
- Test Suites: 1 passed, 1 total
151
+ Test Suites: 1 passed, 1 total
152
152
Tests: 3 passed, 3 total
153
153
` ` `
154
154
<br/>
@@ -168,11 +168,11 @@ async function run() {
168
168
` ` `
169
169
` ` ` javascript
170
170
PASS ./ index .test .js
171
- ✓ throws invalid number
172
- ✓ wait 500 ms
171
+ ✓ throws invalid number
172
+ ✓ wait 500 ms
173
173
✓ test runs
174
174
175
- Test Suites: 1 passed, 1 total
175
+ Test Suites: 1 passed, 1 total
176
176
Tests: 3 passed, 3 total
177
177
` ` `
178
178
<br/>
@@ -205,7 +205,7 @@ const myInput = core.getInput('myInput');
205
205
core .debug (` Hello ${ myInput} from inside a container` );
206
206
207
207
const context = github .context ;
208
- console .log (` We can even get context data, like the repo: ${ context .repo .repo } ` )
208
+ console .log (` We can even get context data, like the repo: ${ context .repo .repo } ` )
209
209
` ` `
210
210
<br/>
211
211
0 commit comments