-
Notifications
You must be signed in to change notification settings - Fork 60.5k
/
workflow-syntax-for-github-actions.md
1251 lines (808 loc) · 53.5 KB
/
workflow-syntax-for-github-actions.md
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
---
title: Workflow syntax for GitHub Actions
shortTitle: Workflow syntax
intro: A workflow is a configurable automated process made up of one or more jobs. You must create a YAML file to define your workflow configuration.
redirect_from:
- /articles/workflow-syntax-for-github-actions
- /github/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions
- /actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions
- /actions/reference/workflow-syntax-for-github-actions
- /actions/learn-github-actions/workflow-syntax-for-github-actions
- /actions/using-workflows/workflow-syntax-for-github-actions
versions:
fpt: '*'
ghes: '*'
ghec: '*'
---
{% data reusables.actions.enterprise-github-hosted-runners %}
## About YAML syntax for workflows
Workflow files use YAML syntax, and must have either a `.yml` or `.yaml` file extension. {% data reusables.actions.learn-more-about-yaml %}
You must store workflow files in the `.github/workflows` directory of your repository.
## `name`
{% data reusables.actions.workflows.workflow-syntax-name %}
## `run-name`
The name for workflow runs generated from the workflow. {% data variables.product.prodname_dotcom %} displays the workflow run name in the list of workflow runs on your repository's "Actions" tab. If `run-name` is omitted or is only whitespace, then the run name is set to event-specific information for the workflow run. For example, for a workflow triggered by a `push` or `pull_request` event, it is set as the commit message or the title of the pull request.
This value can include expressions and can reference the [`github`](/actions/learn-github-actions/contexts#github-context) and [`inputs`](/actions/learn-github-actions/contexts#inputs-context) contexts.
### Example of `run-name`
{% raw %}
```yaml
run-name: Deploy to ${{ inputs.deploy_target }} by @${{ github.actor }}
```
{% endraw %}
## `on`
{% data reusables.actions.workflows.section-triggering-a-workflow %}
## `on.<event_name>.types`
{% data reusables.actions.workflows.section-triggering-a-workflow-types %}
## `on.<pull_request|pull_request_target>.<branches|branches-ignore>`
{% data reusables.actions.workflows.triggering-workflow-branches1 %}
### Example: Including branches
{% data reusables.actions.workflows.triggering-workflow-branches2 %}
### Example: Excluding branches
{% data reusables.actions.workflows.triggering-workflow-branches3 %}
### Example: Including and excluding branches
{% data reusables.actions.workflows.triggering-workflow-branches4 %}
## `on.push.<branches|tags|branches-ignore|tags-ignore>`
{% data reusables.actions.workflows.run-on-specific-branches-or-tags1 %}
### Example: Including branches and tags
{% data reusables.actions.workflows.run-on-specific-branches-or-tags2 %}
### Example: Excluding branches and tags
{% data reusables.actions.workflows.run-on-specific-branches-or-tags3 %}
### Example: Including and excluding branches and tags
{% data reusables.actions.workflows.run-on-specific-branches-or-tags4 %}
## `on.<push|pull_request|pull_request_target>.<paths|paths-ignore>`
{% data reusables.actions.workflows.triggering-a-workflow-paths1 %}
### Example: Including paths
{% data reusables.actions.workflows.triggering-a-workflow-paths2 %}
### Example: Excluding paths
{% data reusables.actions.workflows.triggering-a-workflow-paths3 %}
### Example: Including and excluding paths
{% data reusables.actions.workflows.triggering-a-workflow-paths4 %}
### Git diff comparisons
{% data reusables.actions.workflows.triggering-a-workflow-paths5 %}
## `on.schedule`
{% data reusables.actions.workflows.section-triggering-a-workflow-schedule %}
## `on.workflow_call`
Use `on.workflow_call` to define the inputs and outputs for a reusable workflow. You can also map the secrets that are available to the called workflow. For more information on reusable workflows, see "[AUTOTITLE](/actions/using-workflows/reusing-workflows)."
## `on.workflow_call.inputs`
When using the `workflow_call` keyword, you can optionally specify inputs that are passed to the called workflow from the caller workflow. For more information about the `workflow_call` keyword, see "[AUTOTITLE](/actions/using-workflows/events-that-trigger-workflows#workflow-reuse-events)."
In addition to the standard input parameters that are available, `on.workflow_call.inputs` requires a `type` parameter. For more information, see [`on.workflow_call.inputs.<input_id>.type`](#onworkflow_callinputsinput_idtype).
If a `default` parameter is not set, the default value of the input is `false` for a boolean, `0` for a number, and `""` for a string.
Within the called workflow, you can use the `inputs` context to refer to an input. For more information, see "[AUTOTITLE](/actions/learn-github-actions/contexts#inputs-context)."
If a caller workflow passes an input that is not specified in the called workflow, this results in an error.
### Example of `on.workflow_call.inputs`
{% raw %}
```yaml
on:
workflow_call:
inputs:
username:
description: 'A username passed from the caller workflow'
default: 'john-doe'
required: false
type: string
jobs:
print-username:
runs-on: ubuntu-latest
steps:
- name: Print the input name to STDOUT
run: echo The username is ${{ inputs.username }}
```
{% endraw %}
For more information, see "[AUTOTITLE](/actions/using-workflows/reusing-workflows)."
## `on.workflow_call.inputs.<input_id>.type`
Required if input is defined for the `on.workflow_call` keyword. The value of this parameter is a string specifying the data type of the input. This must be one of: `boolean`, `number`, or `string`.
## `on.workflow_call.outputs`
A map of outputs for a called workflow. Called workflow outputs are available to all downstream jobs in the caller workflow. Each output has an identifier, an optional `description,` and a `value.` The `value` must be set to the value of an output from a job within the called workflow.
In the example below, two outputs are defined for this reusable workflow: `workflow_output1` and `workflow_output2`. These are mapped to outputs called `job_output1` and `job_output2`, both from a job called `my_job`.
### Example of `on.workflow_call.outputs`
{% raw %}
```yaml
on:
workflow_call:
# Map the workflow outputs to job outputs
outputs:
workflow_output1:
description: "The first job output"
value: ${{ jobs.my_job.outputs.job_output1 }}
workflow_output2:
description: "The second job output"
value: ${{ jobs.my_job.outputs.job_output2 }}
```
{% endraw %}
For information on how to reference a job output, see [`jobs.<job_id>.outputs`](#jobsjob_idoutputs). For more information, see "[AUTOTITLE](/actions/using-workflows/reusing-workflows)."
## `on.workflow_call.secrets`
A map of the secrets that can be used in the called workflow.
Within the called workflow, you can use the `secrets` context to refer to a secret.
{% note %}
**Note:** If you are passing the secret to a nested reusable workflow, then you must use [`jobs.<job_id>.secrets`](#jobsjob_idsecrets) again to pass the secret. For more information, see "[AUTOTITLE](/actions/using-workflows/reusing-workflows#passing-secrets-to-nested-workflows)."
{% endnote %}
If a caller workflow passes a secret that is not specified in the called workflow, this results in an error.
### Example of `on.workflow_call.secrets`
{% raw %}
```yaml
on:
workflow_call:
secrets:
access-token:
description: 'A token passed from the caller workflow'
required: false
jobs:
pass-secret-to-action:
runs-on: ubuntu-latest
steps:
# passing the secret to an action
- name: Pass the received secret to an action
uses: ./.github/actions/my-action
with:
token: ${{ secrets.access-token }}
# passing the secret to a nested reusable workflow
pass-secret-to-workflow:
uses: ./.github/workflows/my-workflow
secrets:
token: ${{ secrets.access-token }}
```
{% endraw %}
## `on.workflow_call.secrets.<secret_id>`
A string identifier to associate with the secret.
## `on.workflow_call.secrets.<secret_id>.required`
A boolean specifying whether the secret must be supplied.
## `on.workflow_run.<branches|branches-ignore>`
{% data reusables.actions.workflows.section-specifying-branches %}
## `on.workflow_dispatch`
{% data reusables.actions.workflow-dispatch %}
## `on.workflow_dispatch.inputs`
{% data reusables.actions.workflow-dispatch-inputs %}
### Example of `on.workflow_dispatch.inputs`
{% data reusables.actions.workflow-dispatch-inputs-example %}
## `on.workflow_dispatch.inputs.<input_id>.required`
A boolean specifying whether the input must be supplied.
## `on.workflow_dispatch.inputs.<input_id>.type`
The value of this parameter is a string specifying the data type of the input. This must be one of: `boolean`, `choice`, `number`, `environment` or `string`.
## `permissions`
{% data reusables.actions.jobs.section-assigning-permissions-to-jobs %}
### Defining access for the `GITHUB_TOKEN` scopes
{% data reusables.actions.github-token-available-permissions %}
#### Changing the permissions in a forked repository
{% data reusables.actions.forked-write-permission %}
### Setting the `GITHUB_TOKEN` permissions for all jobs in a workflow
You can specify `permissions` at the top level of a workflow, so that the setting applies to all jobs in the workflow.
#### Example: Setting the `GITHUB_TOKEN` permissions for an entire workflow
{% data reusables.actions.jobs.setting-permissions-all-jobs-example %}
## `env`
A `map` of variables that are available to the steps of all jobs in the workflow. You can also set variables that are only available to the steps of a single job or to a single step. For more information, see [`jobs.<job_id>.env`](#jobsjob_idenv) and [`jobs.<job_id>.steps[*].env`](#jobsjob_idstepsenv).
Variables in the `env` map cannot be defined in terms of other variables in the map.
{% data reusables.repositories.actions-env-var-note %}
### Example of `env`
```yaml
env:
SERVER: production
```
## `defaults`
{% data reusables.actions.jobs.setting-default-values-for-jobs-defaults %}
## `defaults.run`
{% data reusables.actions.jobs.setting-default-values-for-jobs-defaults-run %}
## `defaults.run.shell`
{% data reusables.actions.jobs.setting-default-values-for-jobs-defaults-run-shell %}
## `defaults.run.working-directory`
{% data reusables.actions.jobs.setting-default-values-for-jobs-defaults-run-working-directory %}
## `concurrency`
{% data reusables.actions.jobs.section-using-concurrency %}
## `jobs`
{% data reusables.actions.jobs.section-using-jobs-in-a-workflow %}
## `jobs.<job_id>`
{% data reusables.actions.jobs.section-using-jobs-in-a-workflow-id %}
## `jobs.<job_id>.name`
{% data reusables.actions.jobs.section-using-jobs-in-a-workflow-name %}
## `jobs.<job_id>.permissions`
{% data reusables.actions.jobs.section-assigning-permissions-to-jobs-specific %}
{% data reusables.actions.github-token-scope-descriptions %}
### Defining access for the `GITHUB_TOKEN` scopes
{% data reusables.actions.github-token-available-permissions %}
#### Changing the permissions in a forked repository
{% data reusables.actions.forked-write-permission %}
#### Example: Setting the `GITHUB_TOKEN` permissions for one job in a workflow
{% data reusables.actions.jobs.setting-permissions-specific-jobs-example %}
## `jobs.<job_id>.needs`
{% data reusables.actions.jobs.section-using-jobs-in-a-workflow-needs %}
## `jobs.<job_id>.if`
{% data reusables.actions.jobs.section-using-conditions-to-control-job-execution %}
## `jobs.<job_id>.runs-on`
{% data reusables.actions.jobs.choosing-runner-overview %}
### Choosing {% data variables.product.prodname_dotcom %}-hosted runners
{% data reusables.actions.jobs.choosing-runner-github-hosted %}
### Choosing self-hosted runners
{% data reusables.actions.jobs.choosing-runner-self-hosted %}
### Choosing runners in a group
{% data reusables.actions.jobs.choosing-runner-group %}
## `jobs.<job_id>.environment`
{% data reusables.actions.jobs.section-using-environments-for-jobs %}
## `jobs.<job_id>.concurrency`
{% data reusables.actions.jobs.section-using-concurrency-jobs %}
## `jobs.<job_id>.outputs`
{% data reusables.actions.jobs.section-defining-outputs-for-jobs %}
## `jobs.<job_id>.env`
A `map` of variables that are available to all steps in the job. You can set variables for the entire workflow or an individual step. For more information, see [`env`](#env) and [`jobs.<job_id>.steps[*].env`](#jobsjob_idstepsenv).
{% data reusables.repositories.actions-env-var-note %}
### Example of `jobs.<job_id>.env`
```yaml
jobs:
job1:
env:
FIRST_NAME: Mona
```
## `jobs.<job_id>.defaults`
{% data reusables.actions.jobs.setting-default-values-for-jobs-defaults-job %}
## `jobs.<job_id>.defaults.run`
{% data reusables.actions.jobs.setting-default-values-for-jobs-defaults-job-run %}
## `jobs.<job_id>.defaults.run.shell`
{% data reusables.actions.jobs.setting-default-values-for-jobs-defaults-run-shell %}
## `jobs.<job_id>.defaults.run.working-directory`
{% data reusables.actions.jobs.setting-default-values-for-jobs-defaults-run-working-directory %}
### Example: Setting default `run` step options for a job
{% data reusables.actions.jobs.setting-default-run-value-for-job-example %}
## `jobs.<job_id>.steps`
A job contains a sequence of tasks called `steps`. Steps can run commands, run setup tasks, or run an action in your repository, a public repository, or an action published in a Docker registry. Not all steps run actions, but all actions run as a step. Each step runs in its own process in the runner environment and has access to the workspace and filesystem. Because steps run in their own process, changes to environment variables are not preserved between steps. {% data variables.product.prodname_dotcom %} provides built-in steps to set up and complete a job.
{% data variables.product.prodname_dotcom %} only displays the first 1,000 checks, however, you can run an unlimited number of steps as long as you are within the workflow usage limits. For more information, see "[AUTOTITLE](/actions/learn-github-actions/usage-limits-billing-and-administration)" for {% data variables.product.prodname_dotcom %}-hosted runners and "[AUTOTITLE](/actions/hosting-your-own-runners/managing-self-hosted-runners/about-self-hosted-runners#usage-limits)" for self-hosted runner usage limits.
### Example of `jobs.<job_id>.steps`
{% raw %}
```yaml
name: Greeting from Mona
on: push
jobs:
my-job:
name: My Job
runs-on: ubuntu-latest
steps:
- name: Print a greeting
env:
MY_VAR: Hi there! My name is
FIRST_NAME: Mona
MIDDLE_NAME: The
LAST_NAME: Octocat
run: |
echo $MY_VAR $FIRST_NAME $MIDDLE_NAME $LAST_NAME.
```
{% endraw %}
## `jobs.<job_id>.steps[*].id`
A unique identifier for the step. You can use the `id` to reference the step in contexts. For more information, see "[AUTOTITLE](/actions/learn-github-actions/contexts)."
## `jobs.<job_id>.steps[*].if`
You can use the `if` conditional to prevent a step from running unless a condition is met. {% data reusables.actions.if-supported-contexts %}
{% data reusables.actions.expression-syntax-if %} For more information, see "[AUTOTITLE](/actions/learn-github-actions/expressions)."
### Example: Using contexts
This step only runs when the event type is a `pull_request` and the event action is `unassigned`.
```yaml
steps:
- name: My first step
if: {% raw %}${{ github.event_name == 'pull_request' && github.event.action == 'unassigned' }}{% endraw %}
run: echo This event is a pull request that had an assignee removed.
```
### Example: Using status check functions
The `my backup step` only runs when the previous step of a job fails. For more information, see "[AUTOTITLE](/actions/learn-github-actions/expressions#status-check-functions)."
```yaml
steps:
- name: My first step
uses: octo-org/action-name@main
- name: My backup step
if: {% raw %}${{ failure() }}{% endraw %}
uses: actions/[email protected]
```
### Example: Using secrets
Secrets cannot be directly referenced in `if:` conditionals. Instead, consider setting secrets as job-level environment variables, then referencing the environment variables to conditionally run steps in the job.
If a secret has not been set, the return value of an expression referencing the secret (such as {% raw %}`${{ secrets.SuperSecret }}`{% endraw %} in the example) will be an empty string.
{% raw %}
```yaml
name: Run a step if a secret has been set
on: push
jobs:
my-jobname:
runs-on: ubuntu-latest
env:
super_secret: ${{ secrets.SuperSecret }}
steps:
- if: ${{ env.super_secret != '' }}
run: echo 'This step will only run if the secret has a value set.'
- if: ${{ env.super_secret == '' }}
run: echo 'This step will only run if the secret does not have a value set.'
```
{% endraw %}
For more information, see "[AUTOTITLE](/actions/learn-github-actions/contexts#context-availability)" and "[AUTOTITLE](/actions/security-guides/using-secrets-in-github-actions)."
## `jobs.<job_id>.steps[*].name`
A name for your step to display on {% data variables.product.prodname_dotcom %}.
## `jobs.<job_id>.steps[*].uses`
Selects an action to run as part of a step in your job. An action is a reusable unit of code. You can use an action defined in the same repository as the workflow, a public repository, or in a [published Docker container image](https://hub.docker.com/).
We strongly recommend that you include the version of the action you are using by specifying a Git ref, SHA, or Docker tag. If you don't specify a version, it could break your workflows or cause unexpected behavior when the action owner publishes an update.
* Using the commit SHA of a released action version is the safest for stability and security.
* If the action publishes major version tags, you should expect to receive critical fixes and security patches while still retaining compatibility. Note that this behavior is at the discretion of the action's author.
* Using the default branch of an action may be convenient, but if someone releases a new major version with a breaking change, your workflow could break.
Some actions require inputs that you must set using the [`with`](#jobsjob_idstepswith) keyword. Review the action's README file to determine the inputs required.
Actions are either JavaScript files or Docker containers. If the action you're using is a Docker container you must run the job in a Linux environment. For more details, see [`runs-on`](#jobsjob_idruns-on).
### Example: Using versioned actions
```yaml
steps:
# Reference a specific commit
- uses: actions/checkout@8f4b7f84864484a7bf31766abe9204da3cbe65b3
# Reference the major version of a release
- uses: {% data reusables.actions.action-checkout %}
# Reference a specific version
- uses: {% data reusables.actions.action-checkout %}.2.0
# Reference a branch
- uses: actions/checkout@main
```
### Example: Using a public action
`{owner}/{repo}@{ref}`
You can specify a branch, ref, or SHA in a public {% data variables.product.prodname_dotcom %} repository.
```yaml
jobs:
my_first_job:
steps:
- name: My first step
# Uses the default branch of a public repository
uses: actions/heroku@main
- name: My second step
# Uses a specific version tag of a public repository
uses: actions/[email protected]
```
### Example: Using a public action in a subdirectory
`{owner}/{repo}/{path}@{ref}`
A subdirectory in a public {% data variables.product.prodname_dotcom %} repository at a specific branch, ref, or SHA.
```yaml
jobs:
my_first_job:
steps:
- name: My first step
uses: actions/aws/ec2@main
```
### Example: Using an action in the same repository as the workflow
`./path/to/dir`
The path to the directory that contains the action in your workflow's repository. You must check out your repository before using the action.
{% data reusables.actions.workflows.section-referencing-an-action-from-the-same-repository %}
### Example: Using a Docker Hub action
`docker://{image}:{tag}`
A Docker image published on [Docker Hub](https://hub.docker.com/).
```yaml
jobs:
my_first_job:
steps:
- name: My first step
uses: docker://alpine:3.8
```
{% ifversion fpt or ghec %}
### Example: Using the {% data variables.product.prodname_registry %} {% data variables.product.prodname_container_registry %}
`docker://{host}/{image}:{tag}`
A public Docker image in the {% data variables.product.prodname_registry %} {% data variables.product.prodname_container_registry %}.
```yaml
jobs:
my_first_job:
steps:
- name: My first step
uses: docker://ghcr.io/OWNER/IMAGE_NAME
```
{% endif %}
### Example: Using a Docker public registry action
`docker://{host}/{image}:{tag}`
A Docker image in a public registry. This example uses the Google Container Registry at `gcr.io`.
```yaml
jobs:
my_first_job:
steps:
- name: My first step
uses: docker://gcr.io/cloud-builders/gradle
```
### Example: Using an action inside a different private repository than the workflow
Your workflow must checkout the private repository and reference the action locally. Generate a {% data variables.product.pat_generic %} and add the token as a secret. For more information, see "[AUTOTITLE](/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)" and "[AUTOTITLE](/actions/security-guides/using-secrets-in-github-actions)."
Replace `PERSONAL_ACCESS_TOKEN` in the example with the name of your secret.
```yaml
jobs:
my_first_job:
steps:
- name: Check out repository
uses: {% data reusables.actions.action-checkout %}
with:
repository: octocat/my-private-repo
ref: v1.0
token: {% raw %}${{ secrets.PERSONAL_ACCESS_TOKEN }}{% endraw %}
path: ./.github/actions/my-private-repo
- name: Run my action
uses: ./.github/actions/my-private-repo/my-action
```
Alternatively, use a {% data variables.product.prodname_github_app %} instead of a {% data variables.product.pat_generic %} in order to ensure your workflow continues to run even if the {% data variables.product.pat_generic %} owner leaves. For more information, see "[AUTOTITLE](/apps/creating-github-apps/guides/making-authenticated-api-requests-with-a-github-app-in-a-github-actions-workflow)."
## `jobs.<job_id>.steps[*].run`
Runs command-line programs that do not exceed 21,000 characters using the operating system's shell. If you do not provide a `name`, the step name will default to the text specified in the `run` command.
Commands run using non-login shells by default. You can choose a different shell and customize the shell used to run commands. For more information, see [`jobs.<job_id>.steps[*].shell`](#jobsjob_idstepsshell).
Each `run` keyword represents a new process and shell in the runner environment. When you provide multi-line commands, each line runs in the same shell. For example:
* A single-line command:
```yaml
- name: Install Dependencies
run: npm install
```
* A multi-line command:
```yaml
- name: Clean install dependencies and build
run: |
npm ci
npm run build
```
## `jobs.<job_id>.steps[*].working-directory`
Using the `working-directory` keyword, you can specify the working directory of where to run the command.
```yaml
- name: Clean temp directory
run: rm -rf *
working-directory: ./temp
```
Alternatively, you can specify a default working directory for all `run` steps in a job, or for all `run` steps in the entire workflow. For more information, see "[`defaults.run.working-directory`](/actions/using-workflows/workflow-syntax-for-github-actions#defaultsrunworking-directory)" and "[`jobs.<job_id>.defaults.run.working-directory`](/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_iddefaultsrunworking-directory)."
You can also use a `run` step to run a script. For more information, see "[AUTOTITLE](/actions/writing-workflows/choosing-what-your-workflow-does/adding-scripts-to-your-workflow)."
## `jobs.<job_id>.steps[*].shell`
You can override the default shell settings in the runner's operating system and the job's default using the `shell` keyword. You can use built-in `shell` keywords, or you can define a custom set of shell options. The shell command that is run internally executes a temporary file that contains the commands specified in the `run` keyword.
{% data reusables.actions.supported-shells %}
Alternatively, you can specify a default shell for all `run` steps in a job, or for all `run` steps in the entire workflow. For more information, see "[`defaults.run.shell`](/actions/using-workflows/workflow-syntax-for-github-actions#defaultsrunshell)" and "[`jobs.<job_id>.defaults.run.shell`](/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_iddefaultsrunshell)."
### Example: Running a command using Bash
```yaml
steps:
- name: Display the path
shell: bash
run: echo $PATH
```
### Example: Running a command using Windows `cmd`
```yaml
steps:
- name: Display the path
shell: cmd
run: echo %PATH%
```
### Example: Running a command using PowerShell Core
```yaml
steps:
- name: Display the path
shell: pwsh
run: echo ${env:PATH}
```
### Example: Using PowerShell Desktop to run a command
```yaml
steps:
- name: Display the path
shell: powershell
run: echo ${env:PATH}
```
### Example: Running an inline Python script
```yaml
steps:
- name: Display the path
shell: python
run: |
import os
print(os.environ['PATH'])
```
### Custom shell
You can set the `shell` value to a template string using `command [options] {0} [more_options]`. {% data variables.product.prodname_dotcom %} interprets the first whitespace-delimited word of the string as the command, and inserts the file name for the temporary script at `{0}`.
For example:
```yaml
steps:
- name: Display the environment variables and their values
shell: perl {0}
run: |
print %ENV
```
The command used, `perl` in this example, must be installed on the runner.
{% ifversion fpt or ghec %}
For information about the software included on GitHub-hosted runners, see "[AUTOTITLE](/actions/using-github-hosted-runners/about-github-hosted-runners#supported-software)."
{% endif %}
### Exit codes and error action preference
For built-in shell keywords, we provide the following defaults that are executed by {% data variables.product.prodname_dotcom %}-hosted runners. You should use these guidelines when running shell scripts.
* `bash`/`sh`:
* By default, fail-fast behavior is enforced using `set -e` for both `sh` and `bash`. When `shell: bash` is specified, `-o pipefail` is also applied to enforce early exit from pipelines that generate a non-zero exit status.
* You can take full control over shell parameters by providing a template string to the shell options. For example, `bash {0}`.
* `sh`-like shells exit with the exit code of the last command executed in a script, which is also the default behavior for actions. The runner will report the status of the step as fail/succeed based on this exit code.
* `powershell`/`pwsh`
* Fail-fast behavior when possible. For `pwsh` and `powershell` built-in shell, we will prepend `$ErrorActionPreference = 'stop'` to script contents.
* We append `if ((Test-Path -LiteralPath variable:\LASTEXITCODE)) { exit $LASTEXITCODE }` to powershell scripts so action statuses reflect the script's last exit code.
* Users can always opt out by not using the built-in shell, and providing a custom shell option like: `pwsh -File {0}`, or `powershell -Command "& '{0}'"`, depending on need.
* `cmd`
* There doesn't seem to be a way to fully opt into fail-fast behavior other than writing your script to check each error code and respond accordingly. Because we can't actually provide that behavior by default, you need to write this behavior into your script.
* `cmd.exe` will exit with the error level of the last program it executed, and it will return the error code to the runner. This behavior is internally consistent with the previous `sh` and `pwsh` default behavior and is the `cmd.exe` default, so this behavior remains intact.
## `jobs.<job_id>.steps[*].with`
A `map` of the input parameters defined by the action. Each input parameter is a key/value pair. Input parameters are set as environment variables. The variable is prefixed with `INPUT_` and converted to upper case.
Input parameters defined for a Docker container must use `args`. For more information, see "[`jobs.<job_id>.steps[*].with.args`](#jobsjob_idstepswithargs)."
### Example of `jobs.<job_id>.steps[*].with`
Defines the three input parameters (`first_name`, `middle_name`, and `last_name`) defined by the `hello_world` action. These input variables will be accessible to the `hello-world` action as `INPUT_FIRST_NAME`, `INPUT_MIDDLE_NAME`, and `INPUT_LAST_NAME` environment variables.
```yaml
jobs:
my_first_job:
steps:
- name: My first step
uses: actions/hello_world@main
with:
first_name: Mona
middle_name: The
last_name: Octocat
```
## `jobs.<job_id>.steps[*].with.args`
A `string` that defines the inputs for a Docker container. {% data variables.product.prodname_dotcom %} passes the `args` to the container's `ENTRYPOINT` when the container starts up. An `array of strings` is not supported by this parameter. A single argument that includes spaces should be surrounded by double quotes `""`.
### Example of `jobs.<job_id>.steps[*].with.args`
{% raw %}
```yaml
steps:
- name: Explain why this job ran
uses: octo-org/action-name@main
with:
entrypoint: /bin/echo
args: The ${{ github.event_name }} event triggered this step.
```
{% endraw %}
The `args` are used in place of the `CMD` instruction in a `Dockerfile`. If you use `CMD` in your `Dockerfile`, use the guidelines ordered by preference:
1. Document required arguments in the action's README and omit them from the `CMD` instruction.
1. Use defaults that allow using the action without specifying any `args`.
1. If the action exposes a `--help` flag, or something similar, use that as the default to make your action self-documenting.
## `jobs.<job_id>.steps[*].with.entrypoint`
Overrides the Docker `ENTRYPOINT` in the `Dockerfile`, or sets it if one wasn't already specified. Unlike the Docker `ENTRYPOINT` instruction which has a shell and exec form, `entrypoint` keyword accepts only a single string defining the executable to be run.
### Example of `jobs.<job_id>.steps[*].with.entrypoint`
```yaml
steps:
- name: Run a custom command
uses: octo-org/action-name@main
with:
entrypoint: /a/different/executable
```
The `entrypoint` keyword is meant to be used with Docker container actions, but you can also use it with JavaScript actions that don't define any inputs.
## `jobs.<job_id>.steps[*].env`
Sets variables for steps to use in the runner environment. You can also set variables for the entire workflow or a job. For more information, see [`env`](#env) and [`jobs.<job_id>.env`](#jobsjob_idenv).
{% data reusables.repositories.actions-env-var-note %}
Public actions may specify expected variables in the README file. If you are setting a secret or sensitive value, such as a password or token, you must set secrets using the `secrets` context. For more information, see "[AUTOTITLE](/actions/learn-github-actions/contexts)."
### Example of `jobs.<job_id>.steps[*].env`
{% raw %}
```yaml
steps:
- name: My first action
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
FIRST_NAME: Mona
LAST_NAME: Octocat
```
{% endraw %}
## `jobs.<job_id>.steps[*].continue-on-error`
Prevents a job from failing when a step fails. Set to `true` to allow a job to pass when this step fails.
## `jobs.<job_id>.steps[*].timeout-minutes`
The maximum number of minutes to run the step before killing the process.
## `jobs.<job_id>.timeout-minutes`
The maximum number of minutes to let a job run before {% data variables.product.prodname_dotcom %} automatically cancels it. Default: 360
If the timeout exceeds the job execution time limit for the runner, the job will be canceled when the execution time limit is met instead. For more information about job execution time limits, see "[AUTOTITLE](/actions/learn-github-actions/usage-limits-billing-and-administration#usage-limits)" for {% data variables.product.prodname_dotcom %}-hosted runners and "[AUTOTITLE](/actions/hosting-your-own-runners/managing-self-hosted-runners/about-self-hosted-runners#usage-limits)" for self-hosted runner usage limits.
{% note %}
**Note:** {% data reusables.actions.github-token-expiration %} For self-hosted runners, the token may be the limiting factor if the job timeout is greater than 24 hours. For more information on the `GITHUB_TOKEN`, see "[AUTOTITLE](/actions/security-guides/automatic-token-authentication#about-the-github_token-secret)."
{% endnote %}
## `jobs.<job_id>.strategy`
Use `jobs.<job_id>.strategy` to use a matrix strategy for your jobs. {% data reusables.actions.jobs.about-matrix-strategy %} For more information, see "[AUTOTITLE](/actions/using-jobs/using-a-matrix-for-your-jobs)."
## `jobs.<job_id>.strategy.matrix`
{% data reusables.actions.jobs.using-matrix-strategy %}
### Example: Using a single-dimension matrix
{% data reusables.actions.jobs.single-dimension-matrix %}
### Example: Using a multi-dimension matrix
{% data reusables.actions.jobs.multi-dimension-matrix %}
### Example: Using contexts to create matrices
{% data reusables.actions.jobs.matrix-from-context %}
## `jobs.<job_id>.strategy.matrix.include`
{% data reusables.actions.jobs.matrix-include %}
### Example: Expanding configurations
{% data reusables.actions.jobs.matrix-expand-with-include %}
### Example: Adding configurations
{% data reusables.actions.jobs.matrix-add-with-include %}
## `jobs.<job_id>.strategy.matrix.exclude`
{% data reusables.actions.jobs.matrix-exclude %}
## `jobs.<job_id>.strategy.fail-fast`
{% data reusables.actions.jobs.section-using-a-build-matrix-for-your-jobs-failfast %}
## `jobs.<job_id>.strategy.max-parallel`
{% data reusables.actions.jobs.section-using-a-build-matrix-for-your-jobs-max-parallel %}
## `jobs.<job_id>.continue-on-error`
Prevents a workflow run from failing when a job fails. Set to `true` to allow a workflow run to pass when this job fails.
### Example: Preventing a specific failing matrix job from failing a workflow run
You can allow specific jobs in a job matrix to fail without failing the workflow run. For example, if you wanted to only allow an experimental job with `node` set to `15` to fail without failing the workflow run.
{% raw %}
```yaml
runs-on: ${{ matrix.os }}
continue-on-error: ${{ matrix.experimental }}
strategy:
fail-fast: false
matrix:
node: [13, 14]
os: [macos-latest, ubuntu-latest]
experimental: [false]
include:
- node: 15
os: ubuntu-latest
experimental: true
```
{% endraw %}
## `jobs.<job_id>.container`
{% data reusables.actions.docker-container-os-support %}
{% data reusables.actions.jobs.section-running-jobs-in-a-container %}
## `jobs.<job_id>.container.image`
{% data reusables.actions.jobs.section-running-jobs-in-a-container-image %}
## `jobs.<job_id>.container.credentials`
{% data reusables.actions.jobs.section-running-jobs-in-a-container-credentials %}
## `jobs.<job_id>.container.env`
{% data reusables.actions.jobs.section-running-jobs-in-a-container-env %}
## `jobs.<job_id>.container.ports`
{% data reusables.actions.jobs.section-running-jobs-in-a-container-ports %}
## `jobs.<job_id>.container.volumes`
{% data reusables.actions.jobs.section-running-jobs-in-a-container-volumes %}
## `jobs.<job_id>.container.options`
{% data reusables.actions.jobs.section-running-jobs-in-a-container-options %}
## `jobs.<job_id>.services`
{% data reusables.actions.docker-container-os-support %}
Used to host service containers for a job in a workflow. Service containers are useful for creating databases or cache services like Redis. The runner automatically creates a Docker network and manages the life cycle of the service containers.
If you configure your job to run in a container, or your step uses container actions, you don't need to map ports to access the service or action. Docker automatically exposes all ports between containers on the same Docker user-defined bridge network. You can directly reference the service container by its hostname. The hostname is automatically mapped to the label name you configure for the service in the workflow.
If you configure the job to run directly on the runner machine and your step doesn't use a container action, you must map any required Docker service container ports to the Docker host (the runner machine). You can access the service container using localhost and the mapped port.
For more information about the differences between networking service containers, see "[AUTOTITLE](/actions/using-containerized-services/about-service-containers)."