Use CircleCI version 2.1 at the top of your .circleci/config.yml file.
1
version: 2.1
Add the orbs
stanza below your version, invoking the orb:
1
2
orbs:
slack: circleci/slack@5.1.1
Use slack
elements in your existing workflows and jobs.
Send a custom notification using Slack's Block Kit Builder. Create the payload code and paste it in your notify command's custom parameter. Detailed instructions in the GitHub readme. https://app.slack.com/block-kit-builder
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
version: '2.1'
orbs:
slack: circleci/slack@5.0
jobs:
notify:
docker:
- image: cimg/base:current
steps:
- slack/notify:
custom: |
{
"blocks": [
{
"type": "section",
"fields": [
{
"type": "plain_text",
"text": "*This is a text notification*",
"emoji": true
}
]
}
]
}
event: always
workflows:
send-notification:
jobs:
- notify:
context: slack-secrets
A full test and deploy sample configuration. Test your app on every commit. On tagged commits, place the workflow on-hold after testing, pending manual approval for deployment. Receive a Slack notification when the workflow is placed on hold, and a notification whether the deployment fails or deploys successfully.
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
version: '2.1'
orbs:
slack: circleci/slack@5.0
jobs:
deploy:
docker:
- image: cimg/base:current
steps:
- run: echo "deploy my app"
- slack/notify:
event: fail
mentions: '@EngineeringTeam'
template: basic_fail_1
- slack/notify:
event: pass
template: success_tagged_deploy_1
test:
docker:
- image: cimg/base:current
steps:
- run: echo "test my app"
workflows:
test-and-deploy:
jobs:
- test
- slack/on-hold:
context: slack-secrets
filters:
tags:
only: /^v.*/
requires:
- test
- pause_workflow:
filters:
tags:
only: /^v.*/
requires:
- test
- slack/on-hold
type: approval
- deploy:
filters:
tags:
only: /^v.*/
requires:
- pause_workflow
Send a slack notification when a job fails. This example uses a pre-included template. Custom templates can also be used. The channel parameter can be used to alert a specific Slack channel. Ensure the "slack/notify" command is the last command in a job to accurately capture the status.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
version: '2.1'
orbs:
node: circleci/node:4.1
slack: circleci/slack@5.0
jobs:
deploy:
executor:
name: node/default
steps:
- checkout
- node/install-packages
- run:
command: npm run deploy
- slack/notify:
channel: ABCXYZ
event: fail
template: basic_fail_1
workflows:
deploy_and_notify:
jobs:
- deploy:
context: slack-secrets
Send a Slack notification to a channel and use the same message to post replies in a thread. `thread_id` parameter holds a thread identifier in case there are multiple notifications in the pipeline
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
version: '2.1'
orbs:
node: circleci/node:4.1
slack: circleci/slack@5.0
jobs:
deploy:
executor:
name: node/default
steps:
- slack/notify:
channel: engineering
custom: |
{
"blocks": [
{
"type": "section",
"fields": [
{
"type": "plain_text",
"text": "*Deployment started.*",
"emoji": true
}
]
}
]
}
event: always
thread_id: deployment
- slack/notify:
channel: engineering
custom: |
{
"blocks": [
{
"type": "section",
"fields": [
{
"type": "plain_text",
"text": "*Deployment finished.*",
"emoji": true
}
]
}
]
}
event: always
thread_id: deployment
test:
executor:
name: node/default
steps:
- slack/notify:
channel: engineering
custom: |
{
"blocks": [
{
"type": "section",
"fields": [
{
"type": "plain_text",
"text": "*Tests started.*",
"emoji": true
}
]
}
]
}
event: always
thread_id: testing
- slack/notify:
channel: engineering
custom: |
{
"blocks": [
{
"type": "section",
"fields": [
{
"type": "plain_text",
"text": "*Tests finished.*",
"emoji": true
}
]
}
]
}
event: always
thread_id: testing
workflows:
deploy_and_notify:
jobs:
- deploy
- test:
requires:
- deploy
Send a Slack notification to two channels simultaneously. By default, if no channel parameter is set, the $SLACK_DEFAULT_CHANNEL value will be used (must be set). A custom channel, or comma-separated list of channels can be supplied via the "channel" parameter. It is recommended to use the "channel ID" for the value(s). View the wiki: https://github.com/CircleCI-Public/slack-orb/wiki/How-to-set-Slack-channel
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
version: '2.1'
orbs:
node: circleci/node:4.1
slack: circleci/slack@5.0
jobs:
deploy:
executor:
name: node/default
steps:
- slack/notify:
channel: ABCXYZ, ZXCVBN
custom: |
{
"blocks": [
{
"type": "section",
"fields": [
{
"type": "plain_text",
"text": "*This is a text notification*",
"emoji": true
}
]
}
]
}
event: always
workflows:
deploy_and_notify:
jobs:
- deploy:
context: slack-secrets
Pause a Workflow for manual approval and send a Slack notification with a link to the Workflow.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
version: '2.1'
orbs:
slack: circleci/slack@5.0
workflows:
on-hold-example:
jobs:
- my_test_job
- slack/on-hold:
context: slack-secrets
requires:
- my_test_job
- pause_workflow:
requires:
- my_test_job
- slack/on-hold
type: approval
- my_deploy_job:
requires:
- pause_workflow
Use the "branch_pattern" parameter to limit notifications to specified branches. Useful when a job is executed on multiple branches but you only wish to be notified on a subset of branches. For example: If your "build" job runs on every branch, but you wish to only be notified when a failure occurs on the "main" branch, your config may look like this.
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
version: '2.1'
orbs:
slack: circleci/slack@5.0
jobs:
build:
machine: true
steps:
- run: some build command
- slack/notify:
branch_pattern: main
event: fail
template: basic_fail_1
- slack/notify:
branch_pattern: production
event: fail
mentions: <@U8XXXXXXX>, @UserName
template: basic_fail_1
workflows:
deploy_and_notify:
jobs:
- build:
context: slack-secrets
- deploy:
filters:
branches:
only:
- production
requires:
- build
Send a custom notification using Slack's Block Kit Builder. Create the payload code and paste it in your notify command's custom parameter. Detailed instructions in the GitHub readme. https://app.slack.com/block-kit-builder
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
version: '2.1'
orbs:
slack: circleci/slack@5.0
jobs:
scheduled_notify:
docker:
- image: cimg/base:current
steps:
- slack/notify:
custom: |
{
"blocks": [
{
"type": "section",
"fields": [
{
"type": "plain_text",
"text": "*This is a scheduled text notification*",
"emoji": true
}
]
}
]
}
event: always
scheduled_offset_seconds: 30
workflows:
send-notification:
jobs:
- scheduled_notify:
context: slack-secrets
Use one of our pre-included templates for sending a success notification when a tagged deployment passes. Enter a Channel ID in the channel parameter to specify which slack channel to ping. Ensure the "slack/notify" command is the last command in a job to accurately capture the status.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
version: '2.1'
orbs:
node: circleci/node:4.1
slack: circleci/slack@5.0
jobs:
deploy:
executor:
name: node/default
steps:
- checkout
- node/install-packages
- run:
command: npm run deploy
- slack/notify:
channel: ABCXYZ
event: pass
template: success_tagged_deploy_1
workflows:
deploy_and_notify:
jobs:
- deploy:
context:
- slack-secrets
Insert this job in-line with your standard CircleCI on-hold notification jobs to simulataniously send a Slack notification containing a link to the paused Workflow.
PARAMETER | DESCRIPTION | REQUIRED | DEFAULT | TYPE |
---|---|---|---|---|
branch_pattern | A comma separated list of regex matchable branch names.
Notifications will only be sent if sent from a job from these branches.
By default ".+" will be used to match all branches. Pattern must be a POSIX expression and match the full string, no partial matches.
| No | .+ | string |
channel | Select which channel in which to post to. Channel name or ID will work. You may include a comma separated list of channels if you wish to post to multiple channels at once. Set the "SLACK_DEFAULT_CHANNEL" environment variable for the default channel.
| No | $SLACK_DEFAULT_CHANNEL | string |
circleci_host | CircleCI Host (used as the base for the Workflow URL)
| No | https://circleci.com | string |
custom | (optional) Enter a custom message template.
1. Create your message template using the Block Kit Builder: https://app.slack.com/block-kit-builder/.
2. Insert any desired environment variables.
3. Paste value here.
| No | '' | string |
debug | Runs scripts in debug mode for bash.
View payload and response being sent to slack api.
Enable to view full payload being sent to slack and response being received from the API call.
| No | false | boolean |
invert_match | Invert the branch and tag patterns.
If set to true, notifications will only be sent if sent from a job from branches and tags that do not match the patterns.
| No | false | boolean |
mentions | Exports to the "$SLACK_PARAM_MENTIONS" environment variable for use in templates.
Mention users via the @ symbol: "@USER"
If the username contains a space, the Slack ID must be used with angled brackets: "<@U8XXXXXXX>"
| No | '' | string |
step_name | Specify a custom step name for this command, if desired | No | Slack - Sending Notification | string |
template | (optional) By default this job will send the standard "basic_on_hold_1" template. In order to use a custom template you must also set this value to an empty string. | No | basic_on_hold_1 | string |
thread_id | When set, the first `notify` with a given `thread_id` will appear as a regular slack message.
Any subsequent `notify` usage with the same identifier will be posted within the initial message's thread.
`thread_id` should be set to any arbitrary string to help you identify different threads. See examples for more information.
Enabling thread messages with this parameter implies using a very small amount of cacheing: ~200 B
| No | '' | string |
Notify a Slack channel with a custom message. The environment variables SLACK_ACCESS_TOKEN and SLACK_DEFAULT_CHANNEL must be set for this orb to work. For instructions on how to set them, follow the setup guide available in the wiki: https://github.com/CircleCI-Public/slack-orb/wiki/Setup.
PARAMETER | DESCRIPTION | REQUIRED | DEFAULT | TYPE |
---|---|---|---|---|
branch_pattern | A comma separated list of regex matchable branch names. Notifications will only be sent if sent from a job from these branches. Pattern must match the full string, no partial matches.
| No | '' | string |
channel | Select which channel in which to post to. Channel name or ID will work. You may include a comma separated list of channels if you wish to post to multiple channels at once. Set the "SLACK_DEFAULT_CHANNEL" environment variable for the default channel.
| No | $SLACK_DEFAULT_CHANNEL | string |
circleci_host | A CircleCI Host which used in a message template.
| No | https://circleci.com | string |
custom | Enter a custom message template.
1. Create your message template using the Block Kit Builder: https://app.slack.com/block-kit-builder/.
2. Insert any desired environment variables.
3. Paste value here.
| No | '' | string |
debug | Runs scripts in debug mode for bash.
Enable to view full payload being sent to Slack and response being received from the API call.
Redacted content can be viewed by re-running the job with SSH and accessing the log files referenced in the job output.
When run in a persistent build environment such as CircleCI Runner, these debug log files may remain in the system's temporary filesystem indefinitely and accumulate over time.
| No | false | boolean |
event | In what event should this message send? Options: ["fail", "pass", "always"]
| No | always | enum |
ignore_errors | Ignore errors posting to Slack.
Disable to catch initial setup errors. Re-enable to prevent Slack errors from affecting your pipeline.
| No | true | boolean |
invert_match | Invert the branch and tag patterns.
If set to true, notifications will only be sent if sent from a job from branches and tags that do not match the patterns.
| No | false | boolean |
mentions | Exports to the "$SLACK_PARAM_MENTIONS" environment variable for use in templates.
Mention users via the @ symbol: "@USER"
If the username contains a space, the Slack ID must be used with angled brackets: "<@U8XXXXXXX>"
| No | '' | string |
retries | The amount of retries when posting the message to slack. Defaults to zero. | No | 0 | integer |
retry_delay | The amount of seconds to wait between retries. Defaults to 30. | No | 30 | integer |
scheduled_offset_seconds | When set, the notification is a scheduled message.
| No | 0 | integer |
step_name | Specify a custom step name for this command, if desired | No | Slack - Sending Notification | string |
tag_pattern | A comma separated list of regex matchable tag names. Notifications will only be sent if sent from a job from these branches. Pattern must match the full string, no partial matches.
| No | '' | string |
template | Select which template to use for the notification by its name. The name must be available as an environment variable.
The built-in templates can be found and previewed at: https://github.com/CircleCI-Public/slack-orb/wiki#templates.
Alternatively, you can create and use your own dynamic templates: https://github.com/CircleCI-Public/slack-orb/wiki/Dynamic-Templates.
If left empty and no custom template is provided, the template will be automatically selected based on the job status.
| No | '' | string |
thread_id | When set, the first `notify` with a given `thread_id` will appear as a regular slack message.
Any subsequent `notify` usage with the same identifier will be posted within the initial message's thread.
`thread_id` should be set to any arbitrary string to help you identify different threads. See examples for more information.
Enabling thread messages with this parameter implies using a very small amount of cacheing: ~200 B
| No | '' | string |
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
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
# This code is licensed from CircleCI to the user under the MIT license.
# See here for details: https://circleci.com/developer/orbs/licensing
version: 2.1
description: |
Implement event-based notifications across all of your CI/CD pipelines. Utilizing built-in message templates or Slack's visual Block-Kit builder, create and customize notifications specific to your organization's needs. Supports Linux x86_64, MacOS, Arm64 V8, and Windows.
display:
home_url: https://github.com/CircleCI-Public/slack-orb/wiki
source_url: https://github.com/CircleCI-Public/slack-orb
commands:
notify:
description: |
Notify a Slack channel with a custom message.
The environment variables SLACK_ACCESS_TOKEN and SLACK_DEFAULT_CHANNEL must be set for this orb to work.
For instructions on how to set them, follow the setup guide available in the wiki: https://github.com/CircleCI-Public/slack-orb/wiki/Setup.
parameters:
branch_pattern:
default: ""
description: |
A comma separated list of regex matchable branch names. Notifications will only be sent if sent from a job from these branches. Pattern must match the full string, no partial matches.
type: string
channel:
default: $SLACK_DEFAULT_CHANNEL
description: |
Select which channel in which to post to. Channel name or ID will work. You may include a comma separated list of channels if you wish to post to multiple channels at once. Set the "SLACK_DEFAULT_CHANNEL" environment variable for the default channel.
type: string
circleci_host:
default: https://circleci.com
description: |
A CircleCI Host which used in a message template.
type: string
custom:
default: ""
description: |
Enter a custom message template.
1. Create your message template using the Block Kit Builder: https://app.slack.com/block-kit-builder/.
2. Insert any desired environment variables.
3. Paste value here.
type: string
debug:
default: false
description: |
Runs scripts in debug mode for bash.
Enable to view full payload being sent to Slack and response being received from the API call.
Redacted content can be viewed by re-running the job with SSH and accessing the log files referenced in the job output.
When run in a persistent build environment such as CircleCI Runner, these debug log files may remain in the system's temporary filesystem indefinitely and accumulate over time.
type: boolean
event:
default: always
description: |
In what event should this message send? Options: ["fail", "pass", "always"]
enum:
- fail
- pass
- always
type: enum
ignore_errors:
default: true
description: |
Ignore errors posting to Slack.
Disable to catch initial setup errors. Re-enable to prevent Slack errors from affecting your pipeline.
type: boolean
invert_match:
default: false
description: |
Invert the branch and tag patterns.
If set to true, notifications will only be sent if sent from a job from branches and tags that do not match the patterns.
type: boolean
mentions:
default: ""
description: |
Exports to the "$SLACK_PARAM_MENTIONS" environment variable for use in templates.
Mention users via the @ symbol: "@USER"
If the username contains a space, the Slack ID must be used with angled brackets: "<@U8XXXXXXX>"
type: string
retries:
default: 0
description: The amount of retries when posting the message to slack. Defaults to zero.
type: integer
retry_delay:
default: 30
description: The amount of seconds to wait between retries. Defaults to 30.
type: integer
scheduled_offset_seconds:
default: 0
description: |
When set, the notification is a scheduled message.
type: integer
step_name:
default: Slack - Sending Notification
description: Specify a custom step name for this command, if desired
type: string
tag_pattern:
default: ""
description: |
A comma separated list of regex matchable tag names. Notifications will only be sent if sent from a job from these branches. Pattern must match the full string, no partial matches.
type: string
template:
default: ""
description: |
Select which template to use for the notification by its name. The name must be available as an environment variable.
The built-in templates can be found and previewed at: https://github.com/CircleCI-Public/slack-orb/wiki#templates.
Alternatively, you can create and use your own dynamic templates: https://github.com/CircleCI-Public/slack-orb/wiki/Dynamic-Templates.
If left empty and no custom template is provided, the template will be automatically selected based on the job status.
type: string
thread_id:
default: ""
description: |
When set, the first `notify` with a given `thread_id` will appear as a regular slack message.
Any subsequent `notify` usage with the same identifier will be posted within the initial message's thread.
`thread_id` should be set to any arbitrary string to help you identify different threads. See examples for more information.
Enabling thread messages with this parameter implies using a very small amount of cacheing: ~200 B
type: string
steps:
- run:
command: |
echo 'export CCI_STATUS="fail"' > /tmp/SLACK_JOB_STATUS
name: Slack - Detecting Job Status (FAIL)
shell: bash -eo pipefail
when: on_fail
- run:
command: |
echo 'export CCI_STATUS="pass"' > /tmp/SLACK_JOB_STATUS
name: Slack - Detecting Job Status (PASS)
shell: bash -eo pipefail
when: on_success
- when:
condition:
not:
equal:
- ""
- <<parameters.thread_id>>
steps:
- restore_cache:
keys:
- cache-<< parameters.thread_id >>-{{ .Environment.CIRCLE_PIPELINE_ID }}
when: always
- run:
command: |
#!/usr/bin/env bash
# Workaround for Windows Support
# For details, see: https://github.com/CircleCI-Public/slack-orb/pull/380
# shellcheck source=/dev/null
eval printf '%s' "$SLACK_SCRIPT_NOTIFY"
environment:
SLACK_PARAM_BRANCHPATTERN: <<parameters.branch_pattern>>
SLACK_PARAM_CHANNEL: <<parameters.channel>>
SLACK_PARAM_CIRCLECI_HOST: <<parameters.circleci_host>>
SLACK_PARAM_CUSTOM: <<parameters.custom>>
SLACK_PARAM_DEBUG: <<parameters.debug>>
SLACK_PARAM_EVENT: <<parameters.event>>
SLACK_PARAM_IGNORE_ERRORS: <<parameters.ignore_errors>>
SLACK_PARAM_INVERT_MATCH: <<parameters.invert_match>>
SLACK_PARAM_MENTIONS: <<parameters.mentions>>
SLACK_PARAM_OFFSET: <<parameters.scheduled_offset_seconds>>
SLACK_PARAM_RETRIES: <<parameters.retries>>
SLACK_PARAM_RETRY_DELAY: <<parameters.retry_delay>>
SLACK_PARAM_TAGPATTERN: <<parameters.tag_pattern>>
SLACK_PARAM_TEMPLATE: <<parameters.template>>
SLACK_PARAM_THREAD: <<parameters.thread_id>>
SLACK_SCRIPT_NOTIFY: |
#!/usr/bin/env bash
# shellcheck disable=SC2016,SC3043
if [[ "$SLACK_PARAM_CUSTOM" == \$* ]]; then
echo "Doing substitution custom"
SLACK_PARAM_CUSTOM="$(eval echo "${SLACK_PARAM_CUSTOM}" | circleci env subst)"
fi
if [[ "$SLACK_PARAM_TEMPLATE" == \$* ]]; then
echo "Doing substitution template"
SLACK_PARAM_TEMPLATE="$(eval echo "${SLACK_PARAM_TEMPLATE}" | circleci env subst)"
fi
if [ "$SLACK_PARAM_DEBUG" -eq 1 ]; then
set -x
fi
# Import utils.
eval "$SLACK_SCRIPT_UTILS"
JQ_PATH=/usr/local/bin/jq
BuildMessageBody() {
# Send message
# If sending message, default to custom template,
# if none is supplied, check for a pre-selected template value.
# If none, error.
if [ -n "${SLACK_PARAM_CUSTOM:-}" ]; then
SanitizeVars "$SLACK_PARAM_CUSTOM"
ModifyCustomTemplate
# shellcheck disable=SC2016
CUSTOM_BODY_MODIFIED=$(echo "$CUSTOM_BODY_MODIFIED" | sed 's/\\/\\\\/g' | sed 's/"/\\"/g' | sed 's/`/\\`/g')
T2="$(eval printf '%s' \""$CUSTOM_BODY_MODIFIED"\")"
else
# shellcheck disable=SC2154
if [ -n "${SLACK_PARAM_TEMPLATE:-}" ]; then
TEMPLATE="\$$SLACK_PARAM_TEMPLATE"
elif [ "$CCI_STATUS" = "pass" ]; then
TEMPLATE="\$basic_success_1"
elif [ "$CCI_STATUS" = "fail" ]; then
TEMPLATE="\$basic_fail_1"
else
echo "A template wasn't provided nor is possible to infer it based on the job status. The job status: '$CCI_STATUS' is unexpected."
exit 1
fi
[ -z "${SLACK_PARAM_TEMPLATE:-}" ] && echo "No message template was explicitly chosen. Based on the job status '$CCI_STATUS' the template '$TEMPLATE' will be used."
template_body="$(eval printf '%s' \""$TEMPLATE\"")"
SanitizeVars "$template_body"
# shellcheck disable=SC2016
T1="$(printf '%s' "$template_body" | sed 's/\\/\\\\/g' | sed 's/"/\\"/g' | sed 's/`/\\`/g')"
T2="$(eval printf '%s' \""$T1"\")"
fi
# Insert the default channel. THIS IS TEMPORARY
T2="$(printf '%s' "$T2" | jq ". + {\"channel\": \"$SLACK_DEFAULT_CHANNEL\"}")"
SLACK_MSG_BODY="$T2"
}
NotifyWithRetries() {
local success_request=false
local retry_count=0
while [ "$retry_count" -le "$SLACK_PARAM_RETRIES" ]; do
if SLACK_SENT_RESPONSE=$(curl -s -f -X POST -H 'Content-type: application/json' -H "Authorization: Bearer $SLACK_ACCESS_TOKEN" --data "$SLACK_MSG_BODY" "$1"); then
echo "Notification sent"
success_request=true
break
else
echo "Error sending notification. Retrying..."
retry_count=$((retry_count + 1))
sleep "$SLACK_PARAM_RETRY_DELAY"
fi
done
if [ "$success_request" = false ]; then
echo "Error sending notification. Max retries reached"
exit 1
fi
}
PostToSlack() {
# Post once per channel listed by the channel parameter
# The channel must be modified in SLACK_MSG_BODY
# If thread_id is used a file containing the initial message `thread_ts` per each channel is persisted
# /tmp/SLACK_THREAD_INFO/<channel_name> will contain:
# <thread_id>=12345.12345
# shellcheck disable=SC2001
for i in $(eval echo \""$SLACK_PARAM_CHANNEL"\" | sed "s/,/ /g"); do
# replace non-alpha
SLACK_PARAM_THREAD=$(echo "$SLACK_PARAM_THREAD" | sed -r 's/[^[:alpha:][:digit:].]/_/g')
# check if the invoked `notify` command is intended to post threaded messages &
# check for persisted thread info file for each channel listed in channel parameter
if [ ! "$SLACK_PARAM_THREAD" = "" ] && [ -f "/tmp/SLACK_THREAD_INFO/$i" ]; then
# get the initial message thread_ts targeting the correct channel and thread id
# || [ "$?" = "1" ] - this is used to avoid exit status 1 if grep doesn't match anything
# shellcheck disable=SC2002
SLACK_THREAD_EXPORT=$(grep -m1 "$SLACK_PARAM_THREAD" /tmp/SLACK_THREAD_INFO/"$i" || [ "$?" = "1" ])
if [ ! "$SLACK_THREAD_EXPORT" = "" ]; then
# if there is an initial message with a thread id, load it into the environment
# thread_id=12345.12345
eval "$SLACK_THREAD_EXPORT"
fi
# get the value of the specified thread from the environment
# SLACK_THREAD_TS=12345.12345
SLACK_THREAD_TS=$(eval "echo \"\$$SLACK_PARAM_THREAD\"")
# append the thread_ts to the body for posting the message in the correct thread
SLACK_MSG_BODY=$(echo "$SLACK_MSG_BODY" | jq --arg thread_ts "$SLACK_THREAD_TS" '.thread_ts = $thread_ts')
fi
echo "Sending to Slack Channel: $i"
SLACK_MSG_BODY=$(echo "$SLACK_MSG_BODY" | jq --arg channel "$i" '.channel = $channel')
if [ "$SLACK_PARAM_DEBUG" -eq 1 ]; then
printf "%s\n" "$SLACK_MSG_BODY" >"$SLACK_MSG_BODY_LOG"
echo "The message body being sent to Slack can be found below. To view redacted values, rerun the job with SSH and access: ${SLACK_MSG_BODY_LOG}"
echo "$SLACK_MSG_BODY"
fi
if [ "${SLACK_PARAM_OFFSET:0}" -ne 0 ]; then
if date --version >/dev/null 2>&1; then
# GNU date function
POST_AT=$(date -d "now + ${SLACK_PARAM_OFFSET} seconds" +%s)
elif date -v+1S >/dev/null 2>&1; then
# BSD date function
POST_AT=$(date -v"+${SLACK_PARAM_OFFSET}S" +%s)
else
# Alpine
POST_AT=$(date -u +%s | awk -v sec="$SLACK_PARAM_OFFSET" '{print $1 + sec}')
fi
SLACK_MSG_BODY=$(echo "$SLACK_MSG_BODY" | jq --arg post_at "$POST_AT" '.post_at = ($post_at|tonumber)')
# text is required for scheduled messages
SLACK_MSG_BODY=$(echo "$SLACK_MSG_BODY" | jq '.text = "Dummy fallback text"')
NotifyWithRetries https://slack.com/api/chat.scheduleMessage
else
NotifyWithRetries https://slack.com/api/chat.postMessage
fi
if [ "$SLACK_PARAM_DEBUG" -eq 1 ]; then
printf "%s\n" "$SLACK_SENT_RESPONSE" >"$SLACK_SENT_RESPONSE_LOG"
echo "The response from the API call to Slack can be found below. To view redacted values, rerun the job with SSH and access: ${SLACK_SENT_RESPONSE_LOG}"
echo "$SLACK_SENT_RESPONSE"
fi
SLACK_ERROR_MSG=$(echo "$SLACK_SENT_RESPONSE" | jq '.error')
if [ ! "$SLACK_ERROR_MSG" = "null" ]; then
echo "Slack API returned an error message:"
echo "$SLACK_ERROR_MSG"
echo
echo
echo "View the Setup Guide: https://github.com/CircleCI-Public/slack-orb/wiki/Setup"
if [ "$SLACK_PARAM_IGNORE_ERRORS" = "0" ]; then
exit 1
fi
fi
# check if the invoked `notify` command is intended to post messages in threads
if [ ! "$SLACK_PARAM_THREAD" = "" ]; then
# get message thread_ts from response
SLACK_THREAD_TS=$(echo "$SLACK_SENT_RESPONSE" | jq '.ts')
if [ ! "$SLACK_THREAD_TS" = "null" ]; then
# store the thread_ts in the specified channel for the specified thread_id
mkdir -p /tmp/SLACK_THREAD_INFO
echo "$SLACK_PARAM_THREAD=$SLACK_THREAD_TS" >>/tmp/SLACK_THREAD_INFO/"$i"
fi
fi
done
}
ModifyCustomTemplate() {
# Inserts the required "text" field to the custom json template from block kit builder.
if [ "$(echo "$SLACK_PARAM_CUSTOM" | jq '.text')" = "null" ]; then
CUSTOM_BODY_MODIFIED=$(echo "$SLACK_PARAM_CUSTOM" | jq '. + {"text": ""}')
else
# In case the text field was set manually.
CUSTOM_BODY_MODIFIED=$(echo "$SLACK_PARAM_CUSTOM" | jq '.')
fi
}
InstallJq() {
echo "Checking For JQ + CURL"
if command -v curl >/dev/null 2>&1 && ! command -v jq >/dev/null 2>&1; then
uname -a | grep Darwin >/dev/null 2>&1 && JQ_VERSION=jq-osx-amd64 || JQ_VERSION=jq-linux32
curl -Ls -o "$JQ_PATH" https://github.com/stedolan/jq/releases/download/jq-1.6/"${JQ_VERSION}"
chmod +x "$JQ_PATH"
command -v jq >/dev/null 2>&1
return $?
else
command -v curl >/dev/null 2>&1 || {
echo >&2 "SLACK ORB ERROR: CURL is required. Please install."
exit 1
}
command -v jq >/dev/null 2>&1 || {
echo >&2 "SLACK ORB ERROR: JQ is required. Please install"
exit 1
}
return $?
fi
}
FilterBy() {
if [ -z "$1" ]; then
return
fi
# If any pattern supplied matches the current branch or the current tag, proceed; otherwise, exit with message.
FLAG_MATCHES_FILTER="false"
# shellcheck disable=SC2001
for i in $(echo "$1" | sed "s/,/ /g"); do
if echo "$2" | grep -Eq "^${i}$"; then
FLAG_MATCHES_FILTER="true"
break
fi
done
# If the invert_match parameter is set, invert the match.
if { [ "$FLAG_MATCHES_FILTER" = "false" ] && [ "$SLACK_PARAM_INVERT_MATCH" -eq 0 ]; } ||
{ [ "$FLAG_MATCHES_FILTER" = "true" ] && [ "$SLACK_PARAM_INVERT_MATCH" -eq 1 ]; }; then
# dont send message.
echo "NO SLACK ALERT"
echo
echo "Current reference \"$2\" does not match any matching parameter"
echo "Current matching pattern: $1"
exit 0
fi
}
SetupEnvVars() {
echo "BASH_ENV file: $BASH_ENV"
if [ -f "$BASH_ENV" ]; then
echo "Exists. Sourcing into ENV"
# shellcheck disable=SC1090
. "$BASH_ENV"
else
echo "Does Not Exist. Skipping file execution"
fi
}
CheckEnvVars() {
if [ -n "${SLACK_WEBHOOK:-}" ]; then
echo "It appears you have a Slack Webhook token present in this job."
echo "Please note, Webhooks are no longer used for the Slack Orb (v4 +)."
echo "Follow the setup guide available in the wiki: https://github.com/CircleCI-Public/slack-orb/wiki/Setup"
fi
if [ -z "${SLACK_ACCESS_TOKEN:-}" ]; then
echo "In order to use the Slack Orb (v4 +), an OAuth token must be present via the SLACK_ACCESS_TOKEN environment variable."
echo "Follow the setup guide available in the wiki: https://github.com/CircleCI-Public/slack-orb/wiki/Setup"
exit 1
fi
# If no channel is provided, quit with error
if [ -z "${SLACK_PARAM_CHANNEL:-}" ]; then
echo "No channel was provided. Enter value for SLACK_DEFAULT_CHANNEL env var, or channel parameter"
exit 1
fi
}
ShouldPost() {
if [ "$CCI_STATUS" = "$SLACK_PARAM_EVENT" ] || [ "$SLACK_PARAM_EVENT" = "always" ]; then
# In the event the Slack notification would be sent, first ensure it is allowed to trigger
# on this branch or this tag.
FilterBy "$SLACK_PARAM_BRANCHPATTERN" "${CIRCLE_BRANCH:-}"
FilterBy "$SLACK_PARAM_TAGPATTERN" "${CIRCLE_TAG:-}"
echo "Posting Status"
else
# dont send message.
echo "NO SLACK ALERT"
echo
echo "This command is set to send an alert on: $SLACK_PARAM_EVENT"
echo "Current status: ${CCI_STATUS}"
exit 0
fi
}
SetupLogs() {
if [ "$SLACK_PARAM_DEBUG" -eq 1 ]; then
LOG_PATH="$(mktemp -d 'slack-orb-logs.XXXXXX')"
SLACK_MSG_BODY_LOG="$LOG_PATH/payload.json"
SLACK_SENT_RESPONSE_LOG="$LOG_PATH/response.json"
touch "$SLACK_MSG_BODY_LOG" "$SLACK_SENT_RESPONSE_LOG"
chmod 0600 "$SLACK_MSG_BODY_LOG" "$SLACK_SENT_RESPONSE_LOG"
fi
}
# $1: Template with environment variables to be sanitized.
SanitizeVars() {
[ -z "$1" ] && {
printf '%s\n' "Missing argument."
return 1
}
local template="$1"
# Find all environment variables in the template with the format $VAR or ${VAR}.
# The "|| true" is to prevent bats from failing when no matches are found.
local variables
variables="$(printf '%s\n' "$template" | grep -o -E '\$\{?[a-zA-Z_0-9]*\}?' || true)"
[ -z "$variables" ] && {
printf '%s\n' "Nothing to sanitize."
return 0
}
# Extract the variable names from the matches.
local variable_names
variable_names="$(printf '%s\n' "$variables" | grep -o -E '[a-zA-Z0-9_]+' || true)"
[ -z "$variable_names" ] && {
printf '%s\n' "Nothing to sanitize."
return 0
}
# Find out what OS we're running on.
detect_os
for var in $variable_names; do
# The variable must be wrapped in double quotes before the evaluation.
# Otherwise the newlines will be removed.
local value
value="$(eval printf '%s' \"\$"$var\"")"
[ -z "$value" ] && {
printf '%s\n' "$var is empty or doesn't exist. Skipping it..."
continue
}
printf '%s\n' "Sanitizing $var..."
local sanitized_value="$value"
# Escape backslashes.
sanitized_value="$(printf '%s' "$sanitized_value" | awk '{gsub(/\\/, "&\\"); print $0}')"
# Escape newlines.
sanitized_value="$(printf '%s' "$sanitized_value" | tr -d '\r' | awk 'NR > 1 { printf("\\n") } { printf("%s", $0) }')"
# Escape double quotes.
if [ "$PLATFORM" = "windows" ]; then
sanitized_value="$(printf '%s' "$sanitized_value" | awk '{gsub(/"/, "\\\""); print $0}')"
else
sanitized_value="$(printf '%s' "$sanitized_value" | awk '{gsub(/\"/, "\\\""); print $0}')"
fi
# Write the sanitized value back to the original variable.
# shellcheck disable=SC3045 # This is working on Alpine.
printf -v "$var" "%s" "$sanitized_value"
done
return 0
}
# Will not run if sourced from another script.
# This is done so this script may be tested.
ORB_TEST_ENV="bats-core"
if [ "${0#*"$ORB_TEST_ENV"}" = "$0" ]; then
# shellcheck source=/dev/null
. "/tmp/SLACK_JOB_STATUS"
ShouldPost
SetupEnvVars
SetupLogs
CheckEnvVars
InstallJq
BuildMessageBody
PostToSlack
fi
set +x
SLACK_SCRIPT_UTILS: |
#!/bin/false
# shellcheck shell=bash
# shellcheck disable=SC2154
detect_os() {
detected_platform="$(uname -s | tr '[:upper:]' '[:lower:]')"
case "$detected_platform" in
linux*)
PLATFORM=linux
;;
darwin*)
PLATFORM=macos
;;
msys*|cygwin*)
PLATFORM=windows
;;
*)
printf '%s\n' "Unsupported OS: \"$platform\"."
exit 1
;;
esac
export readonly PLATFORM
}
basic_fail_1: |
{
"text": "CircleCI job failed.",
"blocks": [
{
"type": "header",
"text": {
"type": "plain_text",
"text": "Job Failed. :red_circle:",
"emoji": true
}
},
{
"type": "section",
"fields": [
{
"type": "mrkdwn",
"text": "*Job*: ${CIRCLE_JOB}"
}
]
},
{
"type": "section",
"fields": [
{
"type": "mrkdwn",
"text": "*Project*: $CIRCLE_PROJECT_REPONAME"
},
{
"type": "mrkdwn",
"text": "*Branch*: $CIRCLE_BRANCH"
},
{
"type": "mrkdwn",
"text": "*Author*: $CIRCLE_USERNAME"
}
],
"accessory": {
"type": "image",
"image_url": "https://production-cci-com.imgix.net/blog/media/circle-logo-badge-black.png",
"alt_text": "CircleCI logo"
}
},
{
"type": "section",
"fields": [
{
"type": "mrkdwn",
"text": "*Mentions*: $SLACK_PARAM_MENTIONS"
}
]
},
{
"type": "actions",
"elements": [
{
"type": "button",
"action_id": "basic_fail_view",
"text": {
"type": "plain_text",
"text": "View Job"
},
"url": "${CIRCLE_BUILD_URL}"
}
]
}
]
}
basic_on_hold_1: |
{
"text": "CircleCI job on hold, waiting for approval.",
"blocks": [
{
"type": "header",
"text": {
"type": "plain_text",
"text": "ON HOLD - Awaiting Approval :raised_hand:",
"emoji": true
}
},
{
"type": "section",
"fields": [
{
"type": "mrkdwn",
"text": "*Project*: $CIRCLE_PROJECT_REPONAME"
},
{
"type": "mrkdwn",
"text": "*Branch*: $CIRCLE_BRANCH"
},
{
"type": "mrkdwn",
"text": "*Author*: $CIRCLE_USERNAME"
}
],
"accessory": {
"type": "image",
"image_url": "https://production-cci-com.imgix.net/blog/media/circle-logo-badge-black.png",
"alt_text": "CircleCI logo"
}
},
{
"type": "section",
"fields": [
{
"type": "mrkdwn",
"text": "*Mentions*: $SLACK_PARAM_MENTIONS"
}
]
},
{
"type": "actions",
"elements": [
{
"type": "button",
"action_id": "basic_on_hold_view",
"text": {
"type": "plain_text",
"text": "View Workflow"
},
"url": "${SLACK_PARAM_CIRCLECI_HOST}/workflow-run/${CIRCLE_WORKFLOW_ID}"
}
]
}
]
}
basic_success_1: |
{
"text": "CircleCI job succeeded!",
"blocks": [
{
"type": "header",
"text": {
"type": "plain_text",
"text": "Job Succeeded. :white_check_mark:",
"emoji": true
}
},
{
"type": "section",
"fields": [
{
"type": "mrkdwn",
"text": "*Job*: ${CIRCLE_JOB}"
}
]
},
{
"type": "section",
"fields": [
{
"type": "mrkdwn",
"text": "*Project*: $CIRCLE_PROJECT_REPONAME"
},
{
"type": "mrkdwn",
"text": "*Branch*: $CIRCLE_BRANCH"
},
{
"type": "mrkdwn",
"text": "*Commit*: $CIRCLE_SHA1"
},
{
"type": "mrkdwn",
"text": "*Author*: $CIRCLE_USERNAME"
}
],
"accessory": {
"type": "image",
"image_url": "https://production-cci-com.imgix.net/blog/media/circle-logo-badge-black.png",
"alt_text": "CircleCI logo"
}
},
{
"type": "section",
"fields": [
{
"type": "mrkdwn",
"text": "*Mentions*: $SLACK_PARAM_MENTIONS"
}
]
},
{
"type": "actions",
"elements": [
{
"type": "button",
"action_id": "basic_success_view",
"text": {
"type": "plain_text",
"text": "View Job"
},
"url": "${CIRCLE_BUILD_URL}"
}
]
}
]
}
success_tagged_deploy_1: |
{
"text": "CircleCI job succeeded!",
"blocks": [
{
"type": "header",
"text": {
"type": "plain_text",
"text": "Deployment Successful! :tada:",
"emoji": true
}
},
{
"type": "section",
"fields": [
{
"type": "mrkdwn",
"text": "*Project*: $CIRCLE_PROJECT_REPONAME"
},
{
"type": "mrkdwn",
"text": "*When*: $(date +'%m/%d/%Y %T')"
},
{
"type": "mrkdwn",
"text": "*Tag*: $CIRCLE_TAG"
}
],
"accessory": {
"type": "image",
"image_url": "https://production-cci-com.imgix.net/blog/media/circle-logo-badge-black.png",
"alt_text": "CircleCI logo"
}
},
{
"type": "section",
"fields": [
{
"type": "mrkdwn",
"text": "*Mentions*: $SLACK_PARAM_MENTIONS"
}
]
},
{
"type": "actions",
"elements": [
{
"type": "button",
"action_id": "success_tagged_deploy_view",
"text": {
"type": "plain_text",
"text": "View Job"
},
"url": "${CIRCLE_BUILD_URL}"
}
]
}
]
}
name: << parameters.step_name >>
shell: bash -eo pipefail
when: always
- when:
condition:
not:
equal:
- ""
- <<parameters.thread_id>>
steps:
- save_cache:
key: cache-<< parameters.thread_id >>-{{ .Environment.CIRCLE_PIPELINE_ID }}
paths:
- /tmp/SLACK_THREAD_INFO
when: always
jobs:
on-hold:
description: |
Insert this job in-line with your standard CircleCI on-hold notification jobs to simulataniously send a Slack notification containing a link to the paused Workflow.
docker:
- image: cimg/base:stable
parameters:
branch_pattern:
default: .+
description: |
A comma separated list of regex matchable branch names.
Notifications will only be sent if sent from a job from these branches.
By default ".+" will be used to match all branches. Pattern must be a POSIX expression and match the full string, no partial matches.
type: string
channel:
default: $SLACK_DEFAULT_CHANNEL
description: |
Select which channel in which to post to. Channel name or ID will work. You may include a comma separated list of channels if you wish to post to multiple channels at once. Set the "SLACK_DEFAULT_CHANNEL" environment variable for the default channel.
type: string
circleci_host:
default: https://circleci.com
description: |
CircleCI Host (used as the base for the Workflow URL)
type: string
custom:
default: ""
description: |
(optional) Enter a custom message template.
1. Create your message template using the Block Kit Builder: https://app.slack.com/block-kit-builder/.
2. Insert any desired environment variables.
3. Paste value here.
type: string
debug:
default: false
description: |
Runs scripts in debug mode for bash.
View payload and response being sent to slack api.
Enable to view full payload being sent to slack and response being received from the API call.
type: boolean
invert_match:
default: false
description: |
Invert the branch and tag patterns.
If set to true, notifications will only be sent if sent from a job from branches and tags that do not match the patterns.
type: boolean
mentions:
default: ""
description: |
Exports to the "$SLACK_PARAM_MENTIONS" environment variable for use in templates.
Mention users via the @ symbol: "@USER"
If the username contains a space, the Slack ID must be used with angled brackets: "<@U8XXXXXXX>"
type: string
step_name:
default: Slack - Sending Notification
description: Specify a custom step name for this command, if desired
type: string
template:
default: basic_on_hold_1
description: (optional) By default this job will send the standard "basic_on_hold_1" template. In order to use a custom template you must also set this value to an empty string.
type: string
thread_id:
default: ""
description: |
When set, the first `notify` with a given `thread_id` will appear as a regular slack message.
Any subsequent `notify` usage with the same identifier will be posted within the initial message's thread.
`thread_id` should be set to any arbitrary string to help you identify different threads. See examples for more information.
Enabling thread messages with this parameter implies using a very small amount of cacheing: ~200 B
type: string
resource_class: small
steps:
- notify:
branch_pattern: <<parameters.branch_pattern>>
channel: <<parameters.channel>>
circleci_host: <<parameters.circleci_host>>
custom: <<parameters.custom>>
debug: <<parameters.debug>>
event: always
invert_match: <<parameters.invert_match>>
mentions: <<parameters.mentions>>
step_name: <<parameters.step_name>>
template: <<parameters.template>>
thread_id: <<parameters.thread_id>>
examples:
custom_notification:
description: |
Send a custom notification using Slack's Block Kit Builder.
Create the payload code and paste it in your notify command's custom parameter.
Detailed instructions in the GitHub readme.
https://app.slack.com/block-kit-builder
usage:
version: "2.1"
orbs:
slack: circleci/slack@5.0
jobs:
notify:
docker:
- image: cimg/base:current
steps:
- slack/notify:
custom: |
{
"blocks": [
{
"type": "section",
"fields": [
{
"type": "plain_text",
"text": "*This is a text notification*",
"emoji": true
}
]
}
]
}
event: always
workflows:
send-notification:
jobs:
- notify:
context: slack-secrets
full_deployment_sample:
description: |
A full test and deploy sample configuration.
Test your app on every commit. On tagged commits, place the workflow on-hold after testing, pending manual approval for deployment.
Receive a Slack notification when the workflow is placed on hold, and a notification whether the deployment fails or deploys successfully.
usage:
version: "2.1"
orbs:
slack: circleci/slack@5.0
jobs:
deploy:
docker:
- image: cimg/base:current
steps:
- run: echo "deploy my app"
- slack/notify:
event: fail
mentions: '@EngineeringTeam'
template: basic_fail_1
- slack/notify:
event: pass
template: success_tagged_deploy_1
test:
docker:
- image: cimg/base:current
steps:
- run: echo "test my app"
workflows:
test-and-deploy:
jobs:
- test
- slack/on-hold:
context: slack-secrets
filters:
tags:
only: /^v.*/
requires:
- test
- pause_workflow:
filters:
tags:
only: /^v.*/
requires:
- test
- slack/on-hold
type: approval
- deploy:
filters:
tags:
only: /^v.*/
requires:
- pause_workflow
notify_on_fail_with_template:
description: |
Send a slack notification when a job fails. This example uses a pre-included template. Custom templates can also be used.
The channel parameter can be used to alert a specific Slack channel.
Ensure the "slack/notify" command is the last command in a job to accurately capture the status.
usage:
version: "2.1"
orbs:
node: circleci/node:4.1
slack: circleci/slack@5.0
jobs:
deploy:
executor:
name: node/default
steps:
- checkout
- node/install-packages
- run:
command: npm run deploy
- slack/notify:
channel: ABCXYZ
event: fail
template: basic_fail_1
workflows:
deploy_and_notify:
jobs:
- deploy:
context: slack-secrets
notify_thread:
description: |
Send a Slack notification to a channel and use the same message to post replies in a thread.
`thread_id` parameter holds a thread identifier in case there are multiple notifications in the pipeline
usage:
version: "2.1"
orbs:
node: circleci/node:4.1
slack: circleci/slack@5.0
jobs:
deploy:
executor:
name: node/default
steps:
- slack/notify:
channel: engineering
custom: |
{
"blocks": [
{
"type": "section",
"fields": [
{
"type": "plain_text",
"text": "*Deployment started.*",
"emoji": true
}
]
}
]
}
event: always
thread_id: deployment
- slack/notify:
channel: engineering
custom: |
{
"blocks": [
{
"type": "section",
"fields": [
{
"type": "plain_text",
"text": "*Deployment finished.*",
"emoji": true
}
]
}
]
}
event: always
thread_id: deployment
test:
executor:
name: node/default
steps:
- slack/notify:
channel: engineering
custom: |
{
"blocks": [
{
"type": "section",
"fields": [
{
"type": "plain_text",
"text": "*Tests started.*",
"emoji": true
}
]
}
]
}
event: always
thread_id: testing
- slack/notify:
channel: engineering
custom: |
{
"blocks": [
{
"type": "section",
"fields": [
{
"type": "plain_text",
"text": "*Tests finished.*",
"emoji": true
}
]
}
]
}
event: always
thread_id: testing
workflows:
deploy_and_notify:
jobs:
- deploy
- test:
requires:
- deploy
notify_two_channels:
description: |
Send a Slack notification to two channels simultaneously.
By default, if no channel parameter is set, the $SLACK_DEFAULT_CHANNEL value will be used (must be set).
A custom channel, or comma-separated list of channels can be supplied via the "channel" parameter.
It is recommended to use the "channel ID" for the value(s).
View the wiki: https://github.com/CircleCI-Public/slack-orb/wiki/How-to-set-Slack-channel
usage:
version: "2.1"
orbs:
node: circleci/node:4.1
slack: circleci/slack@5.0
jobs:
deploy:
executor:
name: node/default
steps:
- slack/notify:
channel: ABCXYZ, ZXCVBN
custom: |
{
"blocks": [
{
"type": "section",
"fields": [
{
"type": "plain_text",
"text": "*This is a text notification*",
"emoji": true
}
]
}
]
}
event: always
workflows:
deploy_and_notify:
jobs:
- deploy:
context: slack-secrets
on_hold_notification:
description: |
Pause a Workflow for manual approval and send a Slack notification with a link to the Workflow.
usage:
version: "2.1"
orbs:
slack: circleci/slack@5.0
workflows:
on-hold-example:
jobs:
- my_test_job
- slack/on-hold:
context: slack-secrets
requires:
- my_test_job
- pause_workflow:
requires:
- my_test_job
- slack/on-hold
type: approval
- my_deploy_job:
requires:
- pause_workflow
only_notify_on_branch:
description: |
Use the "branch_pattern" parameter to limit notifications to specified branches. Useful when a job is executed on multiple branches but you only wish to be notified on a subset of branches. For example: If your "build" job runs on every branch, but you wish to only be notified when a failure occurs on the "main" branch, your config may look like this.
usage:
version: "2.1"
orbs:
slack: circleci/slack@5.0
jobs:
build:
machine: true
steps:
- run: some build command
- slack/notify:
branch_pattern: main
event: fail
template: basic_fail_1
- slack/notify:
branch_pattern: production
event: fail
mentions: <@U8XXXXXXX>, @UserName
template: basic_fail_1
workflows:
deploy_and_notify:
jobs:
- build:
context: slack-secrets
- deploy:
filters:
branches:
only:
- production
requires:
- build
scheduled_scheduled:
description: |
Send a custom notification using Slack's Block Kit Builder.
Create the payload code and paste it in your notify command's custom parameter.
Detailed instructions in the GitHub readme.
https://app.slack.com/block-kit-builder
usage:
version: "2.1"
orbs:
slack: circleci/slack@5.0
jobs:
scheduled_notify:
docker:
- image: cimg/base:current
steps:
- slack/notify:
custom: |
{
"blocks": [
{
"type": "section",
"fields": [
{
"type": "plain_text",
"text": "*This is a scheduled text notification*",
"emoji": true
}
]
}
]
}
event: always
scheduled_offset_seconds: 30
workflows:
send-notification:
jobs:
- scheduled_notify:
context: slack-secrets
successful_tagged_deployment:
description: |
Use one of our pre-included templates for sending a success notification when a tagged deployment passes.
Enter a Channel ID in the channel parameter to specify which slack channel to ping.
Ensure the "slack/notify" command is the last command in a job to accurately capture the status.
usage:
version: "2.1"
orbs:
node: circleci/node:4.1
slack: circleci/slack@5.0
jobs:
deploy:
executor:
name: node/default
steps:
- checkout
- node/install-packages
- run:
command: npm run deploy
- slack/notify:
channel: ABCXYZ
event: pass
template: success_tagged_deploy_1
workflows:
deploy_and_notify:
jobs:
- deploy:
context:
- slack-secrets