summaryrefslogtreecommitdiff
path: root/.gitlab-ci.yml
blob: 59e999b801c1aa0135fa09fba825ed18bf1eae91 (plain)
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
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
variables:
  GIT_SSL_NO_VERIFY: "1"

  # Commit of ghc/ci-images repository from which to pull Docker images
  DOCKER_REV: 853f348f9caf38b08740b280296fbd34e09abb3a

  # Sequential version number capturing the versions of all tools fetched by
  # .gitlab/ci.sh. Used for invalidation of GitLab CI cache.
  WINDOWS_TOOLCHAIN_VERSION: 4

  # Disable shallow clones; they break our linting rules
  GIT_DEPTH: 0

  # Always start with a fresh clone to avoid non-hermetic builds
  GIT_STRATEGY: clone

  # Overridden by individual jobs
  CONFIGURE_ARGS: ""

  GIT_SUBMODULE_STRATEGY: "recursive"

  HACKAGE_INDEX_STATE: "2020-12-21T14:48:20Z"

  # Reduce XZ compression level for regular jobs (it is bumped to 9 for releases
  # and nightly jobs). In my experiments I've got the following bindist size in
  # the given time for each compression level (with the quick flavour):
  #
  #     XZ_OPT        Time    Size
  #     -9            4m06s   112 MB
  #     -8            4m00s   114 MB
  #     -7            3m50s   116 MB
  #     -6 (default)  3m40s   118 MB
  #     -5            2m47s   123 MB
  #     -4            1m57s   134 MB
  #     -3            1m03s   129 MB
  #     -2            49.73s  136 MB
  #     -1            37.72s  142 MB
  #     -0            34.40s  156 MB
  #
  XZ_OPT: "-1"
default:
  interruptible: true

stages:
  - tool-lint      # Source linting of the tools
  - quick-build    # A very quick smoke-test to weed out broken commits
  - full-build     # Build all the things
  - packaging      # Source distribution, etc.
  - testing        # head.hackage correctness and compiler performance testing
  - deploy         # push documentation

# Note [The CI Story]
# ~~~~~~~~~~~~~~~~~~~
#
# There are two different types of pipelines:
#
#  - marge-bot merges to `master`. Here we perform an exhaustive validation
#    across all of the platforms which we support. In addition, we push
#    performance metric notes upstream, providing a persistent record of the
#    performance characteristics of the compiler.
#
#  - merge requests. Here we perform a slightly less exhaustive battery of
#    testing. Namely we omit some configurations (e.g. the unregisterised job).
#    These use the merge request's base commit for performance metric
#    comparisons.
#

workflow:
  # N.B. Don't run on wip/ branches, instead on run on merge requests.
  rules:
    - if: $CI_MERGE_REQUEST_ID
    - if: $CI_COMMIT_TAG
    - if: '$CI_COMMIT_BRANCH == "master"'
    - if: '$CI_COMMIT_BRANCH =~ /ghc-[0-9]+\.[0-9]+/'
    - if: '$CI_PIPELINE_SOURCE == "web"'

.nightly: &nightly
  variables:
    XZ_OPT: "-9"
  rules:
    - if: $NIGHTLY
  artifacts:
    when: always
    expire_in: 8 weeks

.release: &release
  variables:
    BUILD_FLAVOUR: "perf"
    XZ_OPT: "-9"
    IGNORE_PERF_FAILURES: "all"
    HADDOCK_HYPERLINKED_SOURCES: "YES"
  artifacts:
    when: always
    expire_in: 1 year
  rules:
    - if: '$RELEASE_JOB == "yes"'

############################################################
# Runner Tags
############################################################
#
# * x86_64-linux: Any Docker-capable x86_64 Linux machine
# * aarch64-linux: Any Docker-capable AArch64 Linux machine
# * x86_64-windows: A x86_64 Windows machine
# * lint: Any Docker-capable x86_64 Linux machine; distinct from
#         x86_64-linux to ensure low-latency availability.
#


############################################################
# tool linting
############################################################

ghc-linters:
  stage: tool-lint
  image: "registry.gitlab.haskell.org/ghc/ci-images/linters:$DOCKER_REV"
  script:
    - git fetch "$CI_MERGE_REQUEST_PROJECT_URL" $CI_MERGE_REQUEST_TARGET_BRANCH_NAME
    - base="$(git merge-base FETCH_HEAD $CI_COMMIT_SHA)"
    - "echo Linting changes between $base..$CI_COMMIT_SHA"
    #    - validate-commit-msg .git $(git rev-list $base..$CI_COMMIT_SHA)
    - validate-whitespace .git $(git rev-list $base..$CI_COMMIT_SHA)
    - .gitlab/linters/check-makefiles.py commits $base $CI_COMMIT_SHA
    - .gitlab/linters/check-cpp.py commits $base $CI_COMMIT_SHA
    - .gitlab/linters/check-version-number.sh
    - python3 utils/checkUniques/check-uniques.py .
  dependencies: []
  tags:
    - lint
  rules:
    - if: $CI_MERGE_REQUEST_ID

# Run mypy Python typechecker on linter scripts.
lint-linters:
  stage: tool-lint
  image: "registry.gitlab.haskell.org/ghc/ci-images/linters:$DOCKER_REV"
  script:
    - mypy .gitlab/linters/*.py
  dependencies: []
  tags:
    - lint

# Check that .T files all parse by listing broken tests.
lint-testsuite:
  stage: tool-lint
  image: "registry.gitlab.haskell.org/ghc/ci-images/x86_64-linux-deb9:$DOCKER_REV"
  script:
    - make -Ctestsuite list_broken TEST_HC=$GHC
  dependencies: []
  tags:
    - lint

# Run mypy Python typechecker on testsuite driver
typecheck-testsuite:
  stage: tool-lint
  image: "registry.gitlab.haskell.org/ghc/ci-images/linters:$DOCKER_REV"
  script:
    - mypy testsuite/driver/runtests.py
  dependencies: []
  tags:
    - lint

# We allow the submodule checker to fail when run on merge requests (to
# accommodate, e.g., haddock changes not yet upstream) but not on `master` or
# Marge jobs.
.lint-submods:
  stage: tool-lint
  image: "registry.gitlab.haskell.org/ghc/ci-images/linters:$DOCKER_REV"
  script:
    - git fetch "$CI_MERGE_REQUEST_PROJECT_URL" $CI_MERGE_REQUEST_TARGET_BRANCH_NAME
    - base="$(git merge-base FETCH_HEAD $CI_COMMIT_SHA)"
    - "echo Linting submodule changes between $base..$CI_COMMIT_SHA"
    - git submodule foreach git remote update
    - submodchecker . $(git rev-list $base..$CI_COMMIT_SHA)
  dependencies: []
  tags:
    - lint

lint-submods:
  extends: .lint-submods
  # Allow failure on merge requests since any necessary submodule patches may
  # not be upstreamed yet.
  rules:
    - if: '$CI_MERGE_REQUEST_LABELS =~ /.*marge_bot_batch_merge_job.*/'
      allow_failure: false
    - allow_failure: true

lint-submods-branch:
  extends: .lint-submods
  script:
    - "echo Linting submodule changes between $CI_COMMIT_BEFORE_SHA..$CI_COMMIT_SHA"
    - git submodule foreach git remote update
    - submodchecker . $(git rev-list $CI_COMMIT_BEFORE_SHA..$CI_COMMIT_SHA)
  rules:
    - if: '$CI_COMMIT_BRANCH == "master"'
    - if: '$CI_COMMIT_BRANCH =~ /ghc-[0.9]+\.[0-9]+/'

.lint-changelogs:
  stage: tool-lint
  image: "registry.gitlab.haskell.org/ghc/ci-images/linters:$DOCKER_REV"
  dependencies: []
  tags:
    - lint
  script:
    - bash .gitlab/linters/check-changelogs.sh

lint-changelogs:
  extends: .lint-changelogs
  # Allow failure since this isn't a final release.
  allow_failure: true
  rules:
    - if: '$CI_COMMIT_BRANCH =~ /ghc-[0.9]+\.[0-9]+/'

lint-release-changelogs:
  extends: .lint-changelogs
  rules:
    - if: '$CI_COMMIT_BRANCH =~ /ghc-[0.9]+\.[0-9]+/'

############################################################
# Validation via Pipelines (hadrian)
############################################################

.validate-hadrian:
  variables:
    BUILD_FLAVOUR: "validate"
  script:
    - .gitlab/ci.sh setup
    - "cabal update --index=$HACKAGE_INDEX_STATE"
    - .gitlab/ci.sh configure
    - .gitlab/ci.sh build_hadrian
    - .gitlab/ci.sh test_hadrian
  cache:
    key: hadrian
    paths:
      - cabal-cache
  dependencies: []
  artifacts:
    reports:
      junit: junit.xml
    expire_in: 2 week
    paths:
      - "$BIN_DIST_NAME.tar.xz"
      - junit.xml

.validate-linux-hadrian:
  extends: .validate-hadrian
  image: "registry.gitlab.haskell.org/ghc/ci-images/x86_64-linux-deb9:$DOCKER_REV"
  variables:
    TEST_ENV: "x86_64-linux-deb9-hadrian"
    BIN_DIST_NAME: "ghc-x86_64-deb9-linux"
  before_script:
    # workaround for docker permissions
    - sudo chown ghc:ghc -R .
    - git submodule sync --recursive
    - git submodule update --init --recursive
    - git checkout .gitmodules
    - "git fetch https://gitlab.haskell.org/ghc/ghc-performance-notes.git refs/notes/perf:refs/notes/perf || true"
  after_script:
    - cp -Rf $HOME/.cabal cabal-cache
    - .gitlab/ci.sh clean
  tags:
    - x86_64-linux

# Verify that Hadrian builds with stack. Note that we don't actually perform a
# build of GHC itself; we merely test that the Hadrian executable builds and
# works (by invoking `hadrian --version`).
stack-hadrian-build:
  extends: .validate-linux-hadrian
  stage: quick-build
  script:
    - .gitlab/ci.sh setup
    - .gitlab/ci.sh configure
    - hadrian/build-stack --version

validate-x86_64-linux-deb9-hadrian:
  extends: .validate-linux-hadrian
  stage: full-build

validate-x86_64-linux-deb9-unreg-hadrian:
  extends: .validate-linux-hadrian
  stage: full-build
  variables:
    CONFIGURE_ARGS: --enable-unregisterised
    TEST_ENV: "x86_64-linux-deb9-unreg-hadrian"

.build-x86_64-linux-deb10-hadrian-cross-aarch64:
  extends: .validate-linux-hadrian
  image: "registry.gitlab.haskell.org/ghc/ci-images/x86_64-linux-deb10:$DOCKER_REV"
  variables:
    BIN_DIST_NAME: "ghc-x86_64-deb9-linux"
    CONFIGURE_ARGS: --with-intree-gmp
    CROSS_TARGET: "aarch64-linux-gnu"

validate-x86_64-linux-deb10-hadrian-cross-aarch64:
  extends: .build-x86_64-linux-deb10-hadrian-cross-aarch64
  stage: full-build
  rules:
    - if: '$CI_MERGE_REQUEST_LABELS =~ /.*cross-compilation.*/'

nightly-x86_64-linux-deb10-hadrian-cross-aarch64:
  <<: *nightly
  extends: .build-x86_64-linux-deb10-hadrian-cross-aarch64
  stage: full-build


############################################################
# GHC-in-GHCi (Hadrian)
############################################################

hadrian-ghc-in-ghci:
  stage: quick-build
  needs: [lint-linters, lint-submods]
  image: "registry.gitlab.haskell.org/ghc/ci-images/x86_64-linux-deb9:$DOCKER_REV"
  before_script:
    # workaround for docker permissions
    - sudo chown ghc:ghc -R .
    - git submodule sync --recursive
    - git submodule update --init --recursive
    - git checkout .gitmodules
  variables:
    GHC_FLAGS: -Werror
  tags:
    - x86_64-linux
  script:
    - git clean -xdf && git submodule foreach git clean -xdf
    - .gitlab/ci.sh setup
    - "cabal update --index=$HACKAGE_INDEX_STATE"
    - .gitlab/ci.sh configure
    # Load ghc-in-ghci then immediately exit and check the modules loaded
    - echo ":q" | hadrian/ghci -j`mk/detect-cpu-count.sh`| tail -n2 | grep "Ok,"
  after_script:
    - cp -Rf $HOME/.cabal cabal-cache
  cache:
    key: hadrian-ghci
    paths:
      - cabal-cache

############################################################
# GHC source code linting
############################################################

.lint-params:
  stage: quick-build
  needs: [lint-submods]
  tags:
    - lint
  image: "registry.gitlab.haskell.org/ghc/ci-images/x86_64-linux-deb9:$DOCKER_REV"
  before_script:
    - export PATH="/opt/toolchain/bin:$PATH"
    # workaround for docker permissions
    - sudo chown ghc:ghc -R .
    - git submodule sync --recursive
    - git submodule update --init --recursive
    - git checkout .gitmodules
    - .gitlab/ci.sh setup
    - "cabal update --index=$HACKAGE_INDEX_STATE"
  after_script:
    - cp -Rf $HOME/.cabal cabal-cache
  variables:
    GHC_FLAGS: -Werror
  cache:
    key: lint
    paths:
      - cabal-cache

lint-libs:
  extends: .lint-params
  variables:
    BUILD_FLAVOUR: default
  script:
    - .gitlab/ci.sh setup
    - .gitlab/ci.sh configure
    - .gitlab/ci.sh run_hadrian lint:base
    - .gitlab/ci.sh run_hadrian lint:compiler

############################################################
# Validation via Pipelines (make)
############################################################

.validate:
  variables:
    TEST_TYPE: test
    MAKE_ARGS: "-Werror"
  script: |
    # Build hyperlinked sources for documentation when building releases
    if [[ "$RELEASE_JOB" = "yes" ]]; then
      HADDOCK_HYPERLINKED_SOURCES=1
    fi
    TIME_START=$(date +%s)
    time .gitlab/ci.sh setup 2>&1
    TIME_SETUP=$(date +%s)
    TIME_SETUP_DELTA=$(expr $TIME_SETUP - $TIME_START)
    echo "Setup took $TIME_SETUP_DELTA seconds"

    time .gitlab/ci.sh configure 2>&1
    TIME_CONFIGURE=$(date +%s)
    TIME_CONFIGURE_DELTA=$(expr $TIME_CONFIGURE - $TIME_SETUP)
    echo "Configure took $TIME_CONFIGURE_DELTA seconds"

    time .gitlab/ci.sh build_make 2>&1
    TIME_BUILD=$(date +%s)
    TIME_BUILD_DELTA=$(expr $TIME_BUILD - $TIME_CONFIGURE)
    echo "Build took $TIME_BUILD_DELTA seconds"

    set +e
    time .gitlab/ci.sh test_make 2>&1
    status=$?
    set -e
    TIME_TEST=$(date +%s)
    TIME_TEST_DELTA=$(expr $TIME_TEST - $TIME_BUILD)
    echo "Test took $TIME_TEST_DELTA seconds"

    echo "=== TIMINGS ==="
    echo "Setup      | $TIME_SETUP_DELTA"
    echo "Configure  | $TIME_CONFIGURE_DELTA"
    echo "Build      | $TIME_BUILD_DELTA"
    echo "Test       | $TIME_TEST_DELTA"
    exit $status

  dependencies: []
  artifacts:
    reports:
      junit: junit.xml
    expire_in: 2 week
    paths:
      - $BIN_DIST_PREP_TAR_COMP
      - junit.xml
      - performance-metrics.tsv

#################################
# x86_64-freebsd
#################################

.build-x86_64-freebsd:
  stage: full-build
  extends: .validate
  tags:
    - x86_64-freebsd
  allow_failure: true
  variables:
    # N.B. we use iconv from ports as I see linker errors when we attempt
    # to use the "native" iconv embedded in libc as suggested by the
    # porting guide [1].
    # [1] https://www.freebsd.org/doc/en/books/porters-handbook/using-iconv.html)
    CONFIGURE_ARGS: "--with-gmp-includes=/usr/local/include --with-gmp-libraries=/usr/local/lib --with-iconv-includes=/usr/local/include --with-iconv-libraries=/usr/local/lib"
    GHC_VERSION: "8.10.1"
    CABAL_INSTALL_VERSION: "3.2.0.0"
    BIN_DIST_PREP_TAR_COMP: "ghc-x86_64-portbld-freebsd.tar.xz"
    TEST_ENV: "x86_64-freebsd"
    BUILD_FLAVOUR: "validate"
  after_script:
    - cp -Rf $HOME/.cabal cabal-cache
    - .gitlab/ci.sh clean
  artifacts:
    when: always
    expire_in: 2 week
  cache:
    key: "freebsd-$GHC_VERSION"
    paths:
      - cabal-cache
      - toolchain

# Conditional due to lack of builder capacity
validate-x86_64-freebsd:
  extends: .build-x86_64-freebsd
  rules:
    - if: '$CI_MERGE_REQUEST_LABELS =~ /.*FreeBSD.*/'

nightly-x86_64-freebsd:
  <<: *nightly
  extends: .build-x86_64-freebsd

release-x86_64-freebsd:
  <<: *release
  extends: .build-x86_64-freebsd

.build-x86_64-freebsd-hadrian:
  extends: .validate-hadrian
  tags:
    - x86_64-freebsd
  allow_failure: true
  variables:
    CONFIGURE_ARGS: "--with-gmp-includes=/usr/local/include --with-gmp-libraries=/usr/local/lib --with-iconv-includes=/usr/local/include --with-iconv-libraries=/usr/local/lib"
    HADRIAN_ARGS: "--docs=no-sphinx"
    GHC_VERSION: 8.6.3
    CABAL_INSTALL_VERSION: 3.0.0.0
    BIN_DIST_NAME: "ghc-x86_64-portbld-freebsd"
    TEST_ENV: "x86_64-freebsd-hadrian"
    BUILD_FLAVOUR: "validate"
  after_script:
    - cp -Rf $HOME/.cabal cabal-cache
    - .gitlab/ci.sh clean
  artifacts:
    when: always
    expire_in: 2 week
  cache:
    key: "freebsd-$GHC_VERSION"
    paths:
      - cabal-cache
      - toolchain

# Disabled due to lack of builder capacity
.validate-x86_64-freebsd-hadrian:
  extends: .build-x86_64-freebsd-hadrian

#################################
# x86_64-darwin
#################################

validate-x86_64-darwin:
  extends: .validate-hadrian
  stage: full-build
  tags:
    - x86_64-darwin-m1

  # for now make this non mandatory to pass.
  allow_failure: true

  variables:
    GHC_VERSION: 8.10.4
    CABAL_INSTALL_VERSION: 3.2.0.0
    BIN_DIST_PREP_TAR_COMP: "ghc-x86_64-apple-darwin.tar.xz"
    MACOSX_DEPLOYMENT_TARGET: "10.7"
    # Only Sierra and onwards supports clock_gettime. See #12858
    ac_cv_func_clock_gettime: "no"
    # Only newer OS Xs support utimensat. See #17895
    ac_cv_func_utimensat: "no"

    TEST_TYPE: test
    MAKE_ARGS: "-Werror"
    # we run on M1's for now, getconf can't be built with nix yet,
    # and we use a pure shell, so we can't/shouldn't use /usr/bin/getconf
    # inside th shell.
    CPUS: 8
    LANG: "en_US.UTF-8"
    # WARNING: this is overridden in the shell.nix, see shell.nix!
    CONFIGURE_ARGS: "--with-intree-gmp --with-curses-libraries=/Library/Developer/CommandLineTools/SDKs/MacOSX.sdk/usr/lib --with-iconv-includes=/Library/Developer/CommandLineTools/SDKs/MacOSX.sdk/usr/include --with-iconv-libraries=/Library/Developer/CommandLineTools/SDKs/MacOSX.sdk/usr/lib"
    HADRIAN_ARGS: "--docs=no-sphinx"
    TEST_ENV: "x86_64-darwin-hadrian"
    BIN_DIST_NAME: "ghc-amd64-apple-darwin"
    BUILD_FLAVOUR: "validate"
    # Due to #19025
    IGNORE_PERF_FAILURES: "all"
    CABAL_CACHE: "cabal-cache-amd64"
  after_script:
    - cp -Rf $HOME/.cabal cabal-cache-amd64
    - .gitlab/ci.sh clean

  # I wish we could just use the nix #! logic, but we can't --run and -i bash
  # behave very differently. -i bash does not pass any nix related env vars
  # the whole $stdenv/setup part seems to be missing.
  script: |
    set -Eeuo pipefail
    function runInNixShell() {
      time nix-shell .gitlab/shell.nix \
        -I nixpkgs=https://github.com/angerman/nixpkgs/archive/75f7281738b.tar.gz \
        --argstr system "x86_64-darwin" \
        --pure \
        --keep GHC_VERSION --keep CABAL_INSTALL_VERSION --keep BUILD_FLAVOUR \
        --keep BIN_DIST_PREP_TAR_COMP --keep CPUS --keep PROJECT_DIR \
        --keep CI_PROJECT_DIR --keep MAKE_ARGS --keep HADRIAN_ARGS --keep CABAL_CACHE \
        --keep LANG --keep CONFIGURE_ARGS --keep TEST_ENV --keep BIN_DIST_NAME \
        --keep MACOSX_DEPLOYMENT_TARGET --keep ac_cv_func_clock_gettime --keep HACKAGE_INDEX_STATE \
        --run "$1" 2>&1
    }
    # fix up config.sub in libraries for the time.
    # aarch64-darwin is not supported in older config.sub's
    TIME_START=$(date +%s)
    find libraries -name config.sub -exec cp config.sub {} \;

    runInNixShell ".gitlab/ci.sh setup" 2>&1
    TIME_SETUP=$(date +%s)
    TIME_SETUP_DELTA=$(expr $TIME_SETUP - $TIME_START)
    echo "Setup took $TIME_SETUP_DELTA seconds"

    runInNixShell "cabal update --index=$HACKAGE_INDEX_STATE" 2>&1

    runInNixShell ".gitlab/ci.sh configure" 2>&1
    TIME_CONFIGURE=$(date +%s)
    TIME_CONFIGURE_DELTA=$(expr $TIME_CONFIGURE - $TIME_SETUP)
    echo "Configure took $TIME_CONFIGURE_DELTA seconds"

    runInNixShell ".gitlab/ci.sh build_hadrian" 2>&1
    TIME_BUILD=$(date +%s)
    TIME_BUILD_DELTA=$(expr $TIME_BUILD - $TIME_CONFIGURE)
    echo "Build took $TIME_BUILD_DELTA seconds"

    set +e
    runInNixShell ".gitlab/ci.sh test_hadrian" 2>&1
    status=$?
    set -e

    TIME_TEST=$(date +%s)
    TIME_TEST_DELTA=$(expr $TIME_TEST - $TIME_BUILD)
    echo "Test took $TIME_TEST_DELTA seconds"

    echo "=== TIMINGS ==="
    echo "Setup      | $TIME_SETUP_DELTA"
    echo "Configure  | $TIME_CONFIGURE_DELTA"
    echo "Build      | $TIME_BUILD_DELTA"
    echo "Test       | $TIME_TEST_DELTA"
    exit $status

  artifacts:
    when: always
    expire_in: 2 week
  cache:
    key: "darwin-x86_64-$GHC_VERSION"
    paths:
      - cabal-cache-amd64
      - cabal-cache-arm64
      - toolchain

validate-aarch64-darwin:
  extends: .validate-hadrian
  stage: full-build
  tags:
    - aarch64-darwin-m1

  # for now make this non mandatory to pass.
  allow_failure: true

  variables:
    TEST_TYPE: test
    MAKE_ARGS: "-Werror"
    GHC_VERSION: 8.10.3
    CABAL_INSTALL_VERSION: 3.2.0.0
    BUILD_FLAVOUR: "perf"
    BIN_DIST_PREP_TAR_COMP: "ghc-arm64-apple-darwin.tar.xz"
    # we run on M1's for now, getconf can't be built with nix yet,
    # and we use a pure shell, so we can't/shouldn't use /usr/bin/getconf
    # inside th shell.
    CPUS: 8
    LANG: "en_US.UTF-8"
    # WARNING: this is overridden in the shell.nix, see shell.nix!
    CONFIGURE_ARGS: "--with-intree-gmp --with-curses-libraries=/Library/Developer/CommandLineTools/SDKs/MacOSX.sdk/usr/lib --with-iconv-includes=/Library/Developer/CommandLineTools/SDKs/MacOSX.sdk/usr/include --with-iconv-libraries=/Library/Developer/CommandLineTools/SDKs/MacOSX.sdk/usr/lib"
    HADRIAN_ARGS: "--docs=no-sphinx"
    BIN_DIST_NAME: "ghc-arm64-apple-darwin"
    TEST_ENV: "aarch64-darwin-hadrian"
    CABAL_CACHE: "cabal-cache-arm64"
  after_script:
    - cp -Rf $HOME/.cabal cabal-cache-arm64
    - .gitlab/ci.sh clean

  # I wish we could just use the nix #! logic, but we can't --run and -i bash
  # behave very differently. -i bash does not pass any nix related env vars
  # the whole $stdenv/setup part seems to be missing.
  script: |
    set -Eeuo pipefail
    function runInNixShell() {
      time nix-shell .gitlab/shell.nix \
        -I nixpkgs=https://github.com/angerman/nixpkgs/archive/75f7281738b.tar.gz \
        --argstr system "aarch64-darwin" \
        --pure \
        --keep GHC_VERSION --keep CABAL_INSTALL_VERSION --keep BUILD_FLAVOUR \
        --keep BIN_DIST_PREP_TAR_COMP --keep CPUS --keep PROJECT_DIR \
        --keep CI_PROJECT_DIR --keep MAKE_ARGS --keep HADRIAN_ARGS --keep CABAL_CACHE  \
        --keep LANG --keep CONFIGURE_ARGS --keep TEST_ENV --keep BIN_DIST_NAME \
        --keep HACKAGE_INDEX_STATE \
        --run "$1" 2>&1
    }
    # fix up config.sub in libraries for the time.
    # aarch64-darwin is not supported in older config.sub's
    TIME_START=$(date +%s)
    find libraries -name config.sub -exec cp config.sub {} \;

    time runInNixShell ".gitlab/ci.sh setup" 2>&1
    TIME_SETUP=$(date +%s)
    TIME_SETUP_DELTA=$(expr $TIME_SETUP - $TIME_START)
    echo "Setup took $TIME_SETUP_DELTA seconds"

    runInNixShell "cabal update --index=$HACKAGE_INDEX_STATE" 2>&1

    runInNixShell ".gitlab/ci.sh configure" 2>&1
    TIME_CONFIGURE=$(date +%s)
    TIME_CONFIGURE_DELTA=$(expr $TIME_CONFIGURE - $TIME_SETUP)
    echo "Setup took $TIME_CONFIGURE_DELTA seconds"

    runInNixShell ".gitlab/ci.sh build_hadrian" 2>&1
    TIME_BUILD=$(date +%s)
    TIME_BUILD_DELTA=$(expr $TIME_BUILD - $TIME_CONFIGURE)
    echo "Build took $TIME_BUILD_DELTA seconds"

    set +e
    runInNixShell ".gitlab/ci.sh test_hadrian" 2>&1
    status=$?
    set -e
    TIME_TEST=$(date +%s)
    TIME_TEST_DELTA=$(expr $TIME_TEST - $TIME_BUILD)
    echo "Test took $TIME_TEST_DELTA seconds"

    echo "=== TIMINGS ==="
    echo "Setup      | $TIME_SETUP_DELTA"
    echo "Configure  | $TIME_CONFIGURE_DELTA"
    echo "Build      | $TIME_BUILD_DELTA"
    echo "Test       | $TIME_TEST_DELTA"
    exit $status

  artifacts:
    when: always
    expire_in: 2 week
  cache:
    key: "darwin-aarch64-$GHC_VERSION"
    paths:
      - cabal-cache-amd64
      - cabal-cache-arm64
      - toolchain

.validate-linux:
  extends: .validate
  tags:
    - x86_64-linux
  variables:
    BUILD_FLAVOUR: "validate"
  before_script:
    # workaround for docker permissions
    - sudo chown ghc:ghc -R .
  after_script:
    - cp -Rf $HOME/.cabal cabal-cache
  cache:
    key: linux
    paths:
      - cabal-cache
      - toolchain

#################################
# aarch64-linux-deb10
#################################

.build-aarch64-linux-deb10:
  extends: .validate-linux
  stage: full-build
  image: "registry.gitlab.haskell.org/ghc/ci-images/aarch64-linux-deb10:$DOCKER_REV"
  allow_failure: true
  variables:
    TEST_ENV: "aarch64-linux-deb10"
    BIN_DIST_PREP_TAR_COMP: "ghc-aarch64-linux-deb10.tar.xz"
  cache:
    key: linux-aarch64-deb10
  tags:
    - aarch64-linux

validate-aarch64-linux-deb10:
  extends: .build-aarch64-linux-deb10
  artifacts:
    when: always
    expire_in: 2 week

nightly-aarch64-linux-deb10:
  <<: *nightly
  extends: .build-aarch64-linux-deb10
  variables:
    TEST_TYPE: slowtest

.build-aarch64-linux-deb10-llvm:
  extends: .build-aarch64-linux-deb10
  stage: full-build
  variables:
    BUILD_FLAVOUR: perf-llvm
  tags:
    - aarch64-linux

validate-aarch64-linux-deb10-llvm:
  extends: .build-aarch64-linux-deb10-llvm
  variables:
    CONFIGURE_ARGS: "CC=/opt/llvm/bin/clang"
    RUNTEST_ARGS: "--way=llvm"
    BUILD_FLAVOUR: perf-llvm
    # No docs, for this build, slows it down unncessarily.
    # We build docs on other platforms already anyway.
    BUILD_SPHINX_HTML: "NO"
    BUILD_SPHINX_INFO: "NO"
    BUILD_SPHINX_PDF: "NO"
    BUILD_SPHINX_MAN: "NO"
  artifacts:
    when: always
    expire_in: 2 week

#################################
# armv7-linux-deb10
#################################

.build-armv7-linux-deb10:
  extends: .validate-linux
  stage: full-build
  image: "registry.gitlab.haskell.org/ghc/ci-images/armv7-linux-deb10:$DOCKER_REV"
  # Due to linker issues
  allow_failure: true
  variables:
    TEST_ENV: "armv7-linux-deb10"
    BIN_DIST_PREP_TAR_COMP: "ghc-armv7-linux-deb10.tar.xz"
    CONFIGURE_ARGS: "--host=armv7-linux-gnueabihf --build=armv7-linux-gnueabihf --target=armv7-linux-gnueabihf"
    # N.B. We disable ld.lld explicitly here because it appears to fail
    # non-deterministically on ARMv7. See #18280.
    LD: "ld.gold"
    GccUseLdOpt: "-fuse-ld=gold"
  cache:
    key: linux-armv7-deb10
  tags:
    - armv7-linux

# Disabled as the build takes over 4 hours
.validate-armv7-linux-deb10:
  extends: .build-armv7-linux-deb10
  artifacts:
    when: always
    expire_in: 2 week

nightly-armv7-linux-deb10:
  <<: *nightly
  extends: .build-armv7-linux-deb10
  variables:
    TEST_TYPE: slowtest

#################################
# i386-linux-deb9
#################################

.build-i386-linux-deb9:
  extends: .validate-linux
  stage: full-build
  image: "registry.gitlab.haskell.org/ghc/ci-images/i386-linux-deb9:$DOCKER_REV"
  variables:
    TEST_ENV: "i386-linux-deb9"
    BIN_DIST_PREP_TAR_COMP: "ghc-i386-deb9-linux.tar.xz"
  cache:
    key: linux-i386-deb9

validate-i386-linux-deb9:
  extends: .build-i386-linux-deb9
  artifacts:
    when: always
    expire_in: 2 week

nightly-i386-linux-deb9:
  <<: *nightly
  extends: .build-i386-linux-deb9
  variables:
    TEST_TYPE: slowtest

#################################
# x86_64-linux-deb9
#################################

.build-x86_64-linux-deb9:
  extends: .validate-linux
  image: "registry.gitlab.haskell.org/ghc/ci-images/x86_64-linux-deb9:$DOCKER_REV"
  variables:
    TEST_ENV: "x86_64-linux-deb9"
    BIN_DIST_PREP_TAR_COMP: "./ghc-x86_64-deb9-linux.tar.xz"
  cache:
    key: linux-x86_64-deb9

# Disabled to reduce CI load
.validate-x86_64-linux-deb9:
  extends: .build-x86_64-linux-deb9
  stage: full-build
  artifacts:
    when: always
    expire_in: 2 week

release-x86_64-linux-deb9:
  <<: *release
  extends: .build-x86_64-linux-deb9
  stage: full-build

nightly-x86_64-linux-deb9:
  <<: *nightly
  extends: .build-x86_64-linux-deb9
  stage: full-build
  variables:
    TEST_TYPE: slowtest

# N.B. Has DEBUG assertions enabled in stage2
validate-x86_64-linux-deb9-debug:
  extends: .build-x86_64-linux-deb9
  stage: full-build
  variables:
    BUILD_FLAVOUR: validate
    # Ensure that stage2 also has DEBUG enabled
    ValidateSpeed: SLOW
    # Override validate flavour default; see #16890.
    BUILD_SPHINX_PDF: "YES"
    TEST_TYPE: slowtest
    TEST_ENV: "x86_64-linux-deb9-debug"
    BIN_DIST_PREP_TAR_COMP: "ghc-x86_64-deb9-linux-debug.tar.xz"
  artifacts:
    when: always
    expire_in: 2 week

validate-x86_64-linux-deb9-integer-simple:
  extends: .build-x86_64-linux-deb9
  stage: full-build
  variables:
    BUILD_FLAVOUR: validate
    BIGNUM_BACKEND: native
    TEST_ENV: "x86_64-linux-deb9-integer-simple-validate"
    BIN_DIST_PREP_TAR_COMP: "ghc-x86_64-deb9-linux-integer-simple.tar.xz"

nightly-x86_64-linux-deb9-integer-simple:
  <<: *nightly
  extends: .build-x86_64-linux-deb9
  stage: full-build
  variables:
    BIGNUM_BACKEND: native
    TEST_ENV: "x86_64-linux-deb9-integer-simple"
    TEST_TYPE: slowtest

.build-x86_64-linux-deb9-tsan:
  extends: .validate-linux-hadrian
  stage: full-build
  variables:
    TEST_ENV: "x86_64-linux-deb9-tsan"
    BUILD_FLAVOUR: "default+thread_sanitizer"
    TSAN_OPTIONS: "suppressions=$CI_PROJECT_DIR/rts/.tsan-suppressions"
    # Haddock is large enough to make TSAN choke without massive quantities of
    # memory.
    HADRIAN_ARGS: "--docs=none"

nightly-x86_64-linux-deb9-tsan:
  <<: *nightly
  extends: .build-x86_64-linux-deb9-tsan

validate-x86_64-linux-deb9-tsan:
  extends: .build-x86_64-linux-deb9-tsan
  when: manual

validate-x86_64-linux-deb9-dwarf:
  extends: .build-x86_64-linux-deb9
  stage: full-build
  variables:
    CONFIGURE_ARGS: "--enable-dwarf-unwind"
    BUILD_FLAVOUR: dwarf
    TEST_ENV: "x86_64-linux-deb9-dwarf"
    BIN_DIST_PREP_TAR_COMP: "ghc-x86_64-deb9-linux-dwarf.tar.xz"

#################################
# x86_64-linux-deb10
#################################

.build-x86_64-linux-deb10:
  extends: .validate-linux
  stage: full-build
  image: "registry.gitlab.haskell.org/ghc/ci-images/x86_64-linux-deb10:$DOCKER_REV"
  variables:
    TEST_ENV: "x86_64-linux-deb10"
    BIN_DIST_PREP_TAR_COMP: "./ghc-x86_64-deb10-linux.tar.xz"
  cache:
    key: linux-x86_64-deb10

# Disabled to alleviate CI load
.validate-x86_64-linux-deb10:
  extends: .build-x86_64-linux-deb10
  stage: full-build

nightly-x86_64-linux-deb10:
  <<: *nightly
  extends: .build-x86_64-linux-deb10
  variables:
    TEST_TYPE: slowtest

release-x86_64-linux-deb10:
  <<: *release
  extends: .build-x86_64-linux-deb10

release-x86_64-linux-deb10-dwarf:
  <<: *release
  extends: .build-x86_64-linux-deb10
  variables:
    CONFIGURE_ARGS: "--enable-dwarf-unwind"
    BUILD_FLAVOUR: dwarf
    IGNORE_PERF_FAILURES: "all"
    TEST_ENV: "x86_64-linux-deb10-dwarf"
    BIN_DIST_PREP_TAR_COMP: "ghc-x86_64-deb10-linux-dwarf.tar.xz"
  artifacts:
    when: always
    expire_in: 1 year

validate-x86_64-linux-deb10-llvm:
  extends: .build-x86_64-linux-deb10
  stage: full-build
  rules:
    - if: '$CI_MERGE_REQUEST_LABELS =~ /.*LLVM backend.*/'
  variables:
    BUILD_FLAVOUR: perf-llvm
    TEST_ENV: "x86_64-linux-deb10-llvm"

nightly-x86_64-linux-deb10-llvm:
  <<: *nightly
  extends: .build-x86_64-linux-deb10
  stage: full-build
  variables:
    BUILD_FLAVOUR: perf-llvm
    TEST_ENV: "x86_64-linux-deb10-llvm"

#################################
# x86_64-linux-ubuntu 20.04
#################################

.build-x86_64-linux-ubuntu2004:
  extends: .validate-linux
  stage: full-build
  image: "registry.gitlab.haskell.org/ghc/ci-images/x86_64-linux-ubuntu20_04:$DOCKER_REV"
  variables:
    TEST_ENV: "x86_64-linux-ubuntu2004"
    BIN_DIST_PREP_TAR_COMP: "./ghc-x86_64-ubuntu2004-linux.tar.xz"
  cache:
    key: linux-x86_64-ubuntu2004

# Disabled to alleviate CI load
.validate-x86_64-linux-ubuntu2004:
  extends: .build-x86_64-linux-ubuntu2004
  stage: full-build

nightly-x86_64-linux-ubuntu2004:
  <<: *nightly
  extends: .build-x86_64-linux-ubuntu2004
  variables:
    TEST_TYPE: slowtest

release-x86_64-linux-ubuntu2004:
  <<: *release
  extends: .build-x86_64-linux-ubuntu2004

#################################
# x86_64-linux-alpine
#################################

.build-x86_64-linux-alpine-hadrian:
  extends: .validate-linux-hadrian
  stage: full-build
  image: "registry.gitlab.haskell.org/ghc/ci-images/x86_64-linux-alpine3_12:$DOCKER_REV"
  # There are currently a few failing tests
  allow_failure: true
  variables:
    TEST_ENV: "x86_64-linux-alpine"
    BIN_DIST_NAME: "ghc-x86_64-alpine-linux"
    # Can't use ld.gold due to #13958.
    CONFIGURE_ARGS: "--disable-ld-override"
    HADRIAN_ARGS: "--docs=no-sphinx"
    # encoding004 due to lack of locale support
    # T10458 due to fact that dynamic linker tries to reload libAS
    BROKEN_TESTS: "encoding004 T10458"
  cache:
    key: linux-x86_64-alpine
  artifacts:
    when: always
    expire_in: 2 week

release-x86_64-linux-alpine-integer-simple:
  extends:
    - .build-x86_64-linux-alpine-hadrian
    - .release
  variables:
    BIGNUM_BACKEND: native

release-x86_64-linux-alpine-integer-gmp:
  extends:
    - .build-x86_64-linux-alpine-hadrian
    - .release
  variables:
    BIGNUM_BACKEND: gmp

nightly-x86_64-linux-alpine:
  <<: *nightly
  extends: .build-x86_64-linux-alpine-hadrian

#################################
# x86_64-linux-centos7
#################################

.build-x86_64-linux-centos7:
  extends: .validate-linux
  stage: full-build
  image: "registry.gitlab.haskell.org/ghc/ci-images/x86_64-linux-centos7:$DOCKER_REV"
  variables:
    # The sphinx release shipped with Centos 7 fails to build out documentation
    BUILD_SPHINX_HTML: "NO"
    BUILD_SPHINX_PDF: "NO"
    TEST_ENV: "x86_64-linux-centos7"
    IGNORE_PERF_FAILURES: "all"
    BIN_DIST_PREP_TAR_COMP: "ghc-x86_64-centos7-linux.tar.xz"
    # CentOS seems to default to ascii
    LANG: "en_US.UTF-8"
  cache:
    key: linux-x86_64-centos7

release-x86_64-linux-centos7:
  <<: *release
  extends: .build-x86_64-linux-centos7

#################################
# x86_64-linux-fedora27
#################################

.build-x86_64-linux-fedora27:
  extends: .validate-linux
  stage: full-build
  image: "registry.gitlab.haskell.org/ghc/ci-images/x86_64-linux-fedora27:$DOCKER_REV"
  variables:
    # LLVM 10 is not available for Fedora27
    LLC: /bin/false
    OPT: /bin/false
    TEST_ENV: "x86_64-linux-fedora27"
  cache:
    key: linux-x86_64-fedora27
  artifacts:
    when: always
    # These are used for head.hackage jobs therefore we keep them around for
    # longer.
    expire_in: 8 week

validate-x86_64-linux-fedora27:
  extends: .build-x86_64-linux-fedora27
  variables:
    BIN_DIST_PREP_TAR_COMP: "ghc-x86_64-fedora27-linux.tar.xz"

release-x86_64-linux-fedora27-dwarf:
  <<: *release
  extends: .build-x86_64-linux-fedora27
  variables:
    HADDOCK_HYPERLINKED_SOURCES: "yes"
    CONFIGURE_ARGS: "--enable-dwarf-unwind"
    BUILD_FLAVOUR: dwarf
    IGNORE_PERF_FAILURES: "all"
    BIN_DIST_PREP_TAR_COMP: "ghc-x86_64-fedora27-linux-dwarf.tar.xz"
    TEST_ENV: "x86_64-linux-fedora27-dwarf"

############################################################
# Validation via Pipelines (Windows)
############################################################

.build-windows:
  before_script:
    - git clean -xdf

    # Setup toolchain
    - bash .gitlab/ci.sh setup
  after_script:
    - |
      Copy-Item -Recurse -Path $Env:APPDATA\cabal -Destination cabal-cache
    - bash .gitlab/ci.sh clean
  dependencies: []
  variables:
    #FORCE_SYMLINKS: 1
    LANG: "en_US.UTF-8"
    SPHINXBUILD: "/mingw64/bin/sphinx-build.exe"
    CABAL_INSTALL_VERSION: "3.2.0.0"
    GHC_VERSION: "8.10.4"
  cache:
    paths:
      - cabal-cache
      - toolchain
      - ghc-tarballs

.build-windows-hadrian:
  extends: .build-windows
  stage: full-build
  variables:
    BUILD_FLAVOUR: "validate"
    # skipping perf tests for now since we build a quick-flavoured GHC,
    # which might result in some broken perf tests?
    HADRIAN_ARGS: "--docs=no-sphinx --skip-perf"

  script:
    - bash .gitlab/ci.sh configure
    - bash .gitlab/ci.sh build_hadrian
    - bash .gitlab/ci.sh test_hadrian
  tags:
    - new-x86_64-windows
    - test
  artifacts:
    reports:
      junit: junit.xml
    expire_in: 2 week
    when: always
    paths:
      - "$BIN_DIST_NAME.tar.xz"
      - junit.xml

.build-x86_64-windows-hadrian:
  extends: .build-windows-hadrian
  variables:
    MSYSTEM: MINGW64
    TEST_ENV: "x86_64-windows"
    BIN_DIST_NAME: "ghc-x86_64-unknown-mingw32"
  cache:
    key: "x86_64-windows-$WINDOWS_TOOLCHAIN_VERSION"

validate-x86_64-windows-hadrian:
  extends: .build-x86_64-windows-hadrian

.build-windows-make:
  extends: .build-windows
  stage: full-build
  variables:
    BUILD_FLAVOUR: "quick"
    BIN_DIST_PREP_TAR_COMP: "ghc-x86_64-mingw32.tar.xz"
  script:
    - bash .gitlab/ci.sh configure
    - bash .gitlab/ci.sh build_make
    - bash .gitlab/ci.sh test_make
  tags:
    - new-x86_64-windows
    - test
  artifacts:
    when: always
    expire_in: 2 week
    reports:
      junit: junit.xml
    paths:
      # N.B. variable interpolation apparently doesn't work on Windows so
      # this can't be $BIN_DIST_PREP_TAR_COMP
      - "ghc-x86_64-mingw32.tar.xz"
      - junit.xml

.build-x86_64-windows-make:
  extends: .build-windows-make
  variables:
    MSYSTEM: MINGW64
    TEST_ENV: "x86_64-windows"
  cache:
    key: "x86_64-windows-$WINDOWS_TOOLCHAIN_VERSION"

nightly-x86_64-windows:
  <<: *nightly
  extends: .build-x86_64-windows-make
  stage: full-build
  variables:
    BUILD_FLAVOUR: "validate"

# Normal Windows validate builds lack profiled libraries; that won't do for
# releases.
release-x86_64-windows:
  <<: *release
  extends: .build-x86_64-windows-hadrian
  variables:
    BUILD_FLAVOUR: "perf"
    IGNORE_PERF_FAILURES: "all"
    HADDOCK_HYPERLINKED_SOURCES: "yes"

release-x86_64-windows-integer-simple:
  <<: *release
  extends: .build-x86_64-windows-hadrian
  variables:
    HADDOCK_HYPERLINKED_SOURCES: "yes"
    BIGNUM_BACKEND: native
    IGNORE_PERF_FAILURES: "all"
    BUILD_FLAVOUR: "perf"
    BIN_DIST_NAME: "ghc-x86_64-mingw32-unknown-nogmp"


############################################################
# Packaging
############################################################

doc-tarball:
  stage: packaging
  needs: [validate-x86_64-linux-deb9-debug, validate-x86_64-windows-hadrian, validate-x86_64-linux-deb9-unreg-hadrian]
  tags:
    - x86_64-linux
  image: "registry.gitlab.haskell.org/ghc/ci-images/x86_64-linux-deb9:$DOCKER_REV"
  dependencies:
    - validate-x86_64-linux-deb9-debug
    - validate-x86_64-windows-hadrian
  variables:
    LINUX_BINDIST: "ghc-x86_64-deb9-linux-debug.tar.xz"
    WINDOWS_BINDIST: "ghc-x86_64-unknown-mingw32.tar.xz"
  artifacts:
    paths:
      - haddock.html.tar.xz
      - libraries.html.tar.xz
      - users_guide.html.tar.xz
      - index.html
      - "*.pdf"
  script:
    - |
      if [ ! -f "$LINUX_BINDIST" ]; then
        echo "Error: $LINUX_BINDIST does not exist. Did the Debian 9 job fail?"
        exit 1
      fi
      if [ ! -f "$WINDOWS_BINDIST" ]; then
        echo "Error: $WINDOWS_BINDIST does not exist. Did the 64-bit Windows job fail?"
        exit 1
      fi
    - rm -Rf docs
    - bash -ex distrib/mkDocs/mkDocs $LINUX_BINDIST $WINDOWS_BINDIST
    - ls -lh
    - mv docs/*.tar.xz docs/index.html .

source-tarball:
  stage: packaging
  needs: [validate-x86_64-linux-deb9-unreg-hadrian]
  tags:
    - x86_64-linux
  image: "registry.gitlab.haskell.org/ghc/ci-images/x86_64-linux-deb9:$DOCKER_REV"
  dependencies: []
  rules:
    - if: $CI_COMMIT_TAG
      when: always
  artifacts:
    paths:
      - ghc-*.tar.xz
      - version
  script:
    - python3 mk/get-win32-tarballs.py download all
    - ./boot
    - ./configure
    - make sdist
    - mv sdistprep/*.xz  .
    - make show! --quiet VALUE=ProjectVersion > version
    - source version
    - echo "$ProjectVersion" > version


############################################################
# Testing via head.hackage
############################################################

# Triggering jobs in the ghc/head.hackage project requires that we have a job
# token for that repository. Furthermore the head.hackage CI job must have
# access to an unprivileged access token with the ability to query the ghc/ghc
# project such that it can find the job ID of the fedora27 job for the current
# pipeline.

.hackage:
  stage: testing
  needs: [doc-tarball]
  variables:
    UPSTREAM_PROJECT_PATH: "$CI_PROJECT_PATH"
    UPSTREAM_PROJECT_ID: "$CI_PROJECT_ID"
    UPSTREAM_PIPELINE_ID: "$CI_PIPELINE_ID"
    EXTRA_HC_OPTS: "-dcore-lint"
  trigger:
    project: "ghc/head.hackage"
    branch: "master"
    strategy: "depend"

hackage:
  extends: .hackage
  when: manual

hackage-label:
  extends: .hackage
  rules:
    - if: '$CI_MERGE_REQUEST_LABELS =~ /.*user-facing.*/'

nightly-hackage:
  rules:
    - if: $NIGHTLY
  extends: .hackage

############################################################
# Nofib testing
############################################################

perf-nofib:
  # This needs to be reverted, and is only
  # an attempt to unbreak master
  allow_failure: true
  stage: testing
  needs: [validate-x86_64-linux-deb9-dwarf, doc-tarball]
  dependencies:
    - validate-x86_64-linux-deb9-dwarf
  image: "registry.gitlab.haskell.org/ghc/ci-images/x86_64-linux-deb9:$DOCKER_REV"
  rules:
    - if: $CI_MERGE_REQUEST_ID
    - if: '$CI_COMMIT_BRANCH == "master"'
    - if: '$CI_COMMIT_BRANCH =~ /ghc-[0.9]+\.[0-9]+/'
  tags:
    - x86_64-linux
  before_script:
    - "cabal update --index=$HACKAGE_INDEX_STATE"
  script:
    - root=$(pwd)/ghc
    - |
      mkdir tmp
      tar -xf ghc-x86_64-deb9-linux-dwarf.tar.xz -C tmp
      pushd tmp/ghc-*/
      ./configure --prefix=$root
      make install
      popd
      rm -Rf tmp
    - export BOOT_HC=$GHC
    - cabal install -w "$BOOT_HC" --lib regex-compat
    - export PATH=$root/bin:$PATH
    - make -C nofib boot mode=fast -j$CPUS
    - "make -C nofib EXTRA_RUNTEST_OPTS='-cachegrind +RTS -V0 -RTS' NoFibRuns=1 mode=fast -j$CPUS 2>&1 | tee nofib.log"
  artifacts:
    expire_in: 12 week
    when: always
    paths:
      - nofib.log

############################################################
# Ad-hoc performance testing
############################################################

perf:
  stage: testing
  needs: [validate-x86_64-linux-deb9-dwarf, doc-tarball]
  dependencies:
    - validate-x86_64-linux-deb9-dwarf
  image: "registry.gitlab.haskell.org/ghc/ci-images/x86_64-linux-deb9:$DOCKER_REV"
  rules:
    - if: $CI_MERGE_REQUEST_ID
    - if: '$CI_COMMIT_BRANCH == "master"'
    - if: '$CI_COMMIT_BRANCH =~ /ghc-[0.9]+\.[0-9]+/'
  tags:
    - x86_64-linux-perf
  script:
    - root=$(pwd)/ghc
    - |
      mkdir tmp
      tar -xf ghc-x86_64-deb9-linux-dwarf.tar.xz -C tmp
      pushd tmp/ghc-*/
      ./configure --prefix=$root
      make install
      popd
      rm -Rf tmp
    - export BOOT_HC=$(which ghc)
    - export HC=$root/bin/ghc
    - .gitlab/ci.sh perf_test
  artifacts:
    expire_in: 2 year
    when: always
    paths:
      - out


############################################################
# Documentation deployment via GitLab Pages
############################################################

pages:
  stage: deploy
  needs: [doc-tarball]
  dependencies:
    - doc-tarball
  image: ghcci/x86_64-linux-deb9:0.2
  # See #18973
  allow_failure: true
  tags:
    - x86_64-linux
  script:
    - mkdir -p public/doc
    - tar -xf haddock.html.tar.xz -C public/doc
    - tar -xf libraries.html.tar.xz -C public/doc
    - tar -xf users_guide.html.tar.xz -C public/doc
    - |
      cat >public/index.html <<EOF
      <!DOCTYPE HTML>
      <meta charset="UTF-8">
      <meta http-equiv="refresh" content="1; url=doc/">
      EOF
    - cp -f index.html public/doc
  rules:
    # N.B. only run this on ghc/ghc since the deployed pages are quite large
    # and we only serve GitLab Pages for ghc/ghc.
    - if: '$CI_COMMIT_BRANCH == "master" && $CI_PROJECT_NAMESPACE == "ghc"'
  artifacts:
    paths:
      - public