@@ -5,6 +5,18 @@ description: >-
5
5
template :
6
6
repo : " writing-javascript-actions-template"
7
7
name : " writing-javascript-actions"
8
+
9
+ # Repo artifacts:
10
+ # 1. (Issue) Start here!
11
+ # 2. (PR) Create my-workflow.yml
12
+ # 3. (Issue) Your first JavaScript action
13
+ # 4. (PR) Hello Action
14
+ # 5. (Issue) Knock Knock...
15
+ # 6. (PR) External APIs
16
+ # 7. (Issue) Consuming Action Outputs
17
+ # 8. (PR) Use Outputs
18
+ # 9. (Issue) Last minute notes
19
+
8
20
before :
9
21
- type : updateBranchProtection
10
22
- type : createLabel
@@ -90,8 +102,8 @@ steps:
90
102
data :
91
103
workflowFile : " %payload.repository.html_url%/edit/%actions.iwPr.data.head.ref%/.github/workflows/my-workflow.yml"
92
104
93
- - title : Add an Action reference
94
- description : Add an Action reference to the workflow file
105
+ - title : Prep the workflow
106
+ description : Prepare the workflow for your future action
95
107
event : pull_request.synchronize
96
108
link : " {{ repoUrl }}/pull/2"
97
109
actions :
@@ -103,9 +115,10 @@ steps:
103
115
data :
104
116
workflowFile : " %payload.repository.html_url%/edit/%actions.workflowPr.data.head.ref%/.github/workflows/my-workflow.yml"
105
117
106
- - title : On to your development environment
107
- description : Lets prepare your environemtn to start writing Actions
118
+ - title : Add an Action reference
119
+ description : Add an Action reference to the workflow file
108
120
event : pull_request.synchronize
121
+ link : " {{ repoUrl }}/pull/2"
109
122
actions :
110
123
- type : createIssue
111
124
title : Your first JavaScript action
@@ -119,10 +132,10 @@ steps:
119
132
pullRequest : Create my-workflow.yml
120
133
- type : mergePullRequest
121
134
122
- - title : Creating the Action metadata
123
- description : Create an action.yml file and add necessary metatdata for our Action
135
+ - title : On to your development environment
136
+ description : Lets prepare your environment to start writing Actions
124
137
event : push
125
- # link: "{{ repoUrl }}/issue1/1 "
138
+ link : " {{ repoUrl }}/issues/3 "
126
139
actions :
127
140
- type : gate
128
141
left : " %payload.ref%"
@@ -155,9 +168,10 @@ steps:
155
168
with : 05_create-metadata.md
156
169
issue : Hello Action
157
170
158
- - title : Create the Action entrypoint
159
- description : time to start adding code to main.js
171
+ - title : Creating the Action metadata
172
+ description : Create an action.yml file and add necessary metatdata for our Action
160
173
event : pull_request.synchronize
174
+ link : " {{ repoUrl }}/pull/4"
161
175
actions :
162
176
- type : respond
163
177
with : 06_explain-runs.md
@@ -168,9 +182,10 @@ steps:
168
182
data :
169
183
actionsUrl : " %payload.repository.html_url%/actions"
170
184
171
- - title : Adding input parameters
172
- description : extend your action to accept input parameters
185
+ - title : Create the Action entrypoint
186
+ description : Add code to main.js file
173
187
event : pull_request.synchronize # ideally would like the workflow completing to tigger this
188
+ link : " {{ repoUrl }}/pull/4"
174
189
actions :
175
190
- type : respond
176
191
with : 07_hello-result.md
@@ -182,8 +197,9 @@ steps:
182
197
with : 07_update-files.md
183
198
184
199
- title : Exploring your input parameters
185
- description : view the results of adding input parameter
200
+ description : View the results of adding input parameter
186
201
event : pull_request.synchronize # ideally would like workflow complete to trigger this
202
+ link : " {{ repoUrl }}/pull/4"
187
203
actions :
188
204
- type : respond
189
205
with : 08_input-result.md
@@ -194,8 +210,9 @@ steps:
194
210
with : 08_experiment.md
195
211
196
212
- title : Integrating Actions with external APIs
197
- description : Write a new Action that call an external API
213
+ description : Write a new Action that calls an external API
198
214
event : pull_request.closed
215
+ link : " {{ repoUrl }}/pull/4"
199
216
actions :
200
217
- type : updateBranchProtection
201
218
- type : createIssue
@@ -220,7 +237,7 @@ steps:
220
237
- title : Prevent the workflow from running
221
238
description : Comment out the lines in the workflow to prevent unwanted runs
222
239
event : pull_request
223
- # link: "{{ repoUrl }}/issue1/1 "
240
+ link : " {{ repoUrl }}/issues/5 "
224
241
actions :
225
242
- type : gate
226
243
gates :
@@ -252,6 +269,7 @@ steps:
252
269
- title : Create your new Action metadata
253
270
description : Add action.yml file for new joke action
254
271
event : pull_request.synchronize
272
+ link : " {{ repoUrl }}/pull/6"
255
273
actions :
256
274
- type : gate
257
275
left : " %payload.pull_request.title%"
@@ -263,6 +281,7 @@ steps:
263
281
- title : Create your Actions JavaScript files
264
282
description : Add joke.j and main.js to your Action
265
283
event : pull_request.synchronize
284
+ link : " {{ repoUrl }}/pull/6"
266
285
actions :
267
286
- type : gate
268
287
left : " %payload.pull_request.title%"
@@ -274,6 +293,7 @@ steps:
274
293
- title : Use the joke Action in a workflow
275
294
description : Edit the workflow file to now use the newly created joke Action
276
295
event : pull_request.synchronize
296
+ link : " {{ repoUrl }}/pull/6"
277
297
actions :
278
298
- type : gate
279
299
left : " %payload.pull_request.title%"
@@ -291,7 +311,7 @@ steps:
291
311
- title : Having Actions tell a joke... or two
292
312
description : Wait for your Action to present you with a joke
293
313
event : pull_request.synchronize
294
- # link: "{{ repoUrl }}/pull/2 "
314
+ link : " {{ repoUrl }}/pull/6 "
295
315
actions :
296
316
- type : removeBranchProtection
297
317
- type : respond
@@ -303,6 +323,7 @@ steps:
303
323
- title : Configure the workflow for a third Action
304
324
description : Edit the workflow to accomodate the third action
305
325
event : pull_request.closed
326
+ link : " {{ repoUrl }}/pull/6"
306
327
actions :
307
328
- type : updateBranchProtection
308
329
- type : createIssue
@@ -321,7 +342,7 @@ steps:
321
342
- title : Write the final Action
322
343
description : Create an Action that consumes output from another Action and uses Octokit
323
344
event : pull_request
324
- # link: "{{ repoUrl }}/issue1/1 "
345
+ link : " {{ repoUrl }}/issues/7 "
325
346
actions :
326
347
- type : gate
327
348
gates :
@@ -353,7 +374,7 @@ steps:
353
374
- title : Add third Actions metadata
354
375
description : Create the metadata for the third Action
355
376
event : pull_request.synchronize
356
- # link: "{{ repoUrl }}/pull/2 "
377
+ link : " {{ repoUrl }}/pull/8 "
357
378
actions :
358
379
- type : gate
359
380
left : " %payload.pull_request.title%"
@@ -365,7 +386,7 @@ steps:
365
386
- title : Add third Actions JavaScript files
366
387
description : Create the JavaScript files for the third Action
367
388
event : pull_request.synchronize
368
- # link: "{{ repoUrl }}/pull/2 "
389
+ link : " {{ repoUrl }}/pull/8 "
369
390
actions :
370
391
- type : gate
371
392
left : " %payload.pull_request.title%"
@@ -379,7 +400,7 @@ steps:
379
400
- title : Trigger the third Action
380
401
description : Add a pull request label to trigger the workflow
381
402
event : pull_request.synchronize
382
- # link: "{{ repoUrl }}/pull/2 "
403
+ link : " {{ repoUrl }}/pull/8 "
383
404
actions :
384
405
- type : gate
385
406
left : " %payload.pull_request.title%"
@@ -394,6 +415,7 @@ steps:
394
415
- title : Wrapping things up
395
416
description : Final notes before you go
396
417
event : pull_request.closed
418
+ link : " {{ repoUrl }}/pull/8"
397
419
actions :
398
420
- type : createIssue
399
421
title : Last minute notes
0 commit comments