-
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Taskfile.yml
1196 lines (1075 loc) · 41.6 KB
/
Taskfile.yml
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
---
version: '3'
includes:
ansible:
taskfile: ./.config/taskfiles/ansible/Taskfile.yml
optional: true
ansible:ansibler:
taskfile: ./.config/taskfiles/ansible/Taskfile-ansibler.yml
optional: true
ansible:playbook:
taskfile: ./.config/taskfiles/ansible/Taskfile-playbook.yml
optional: true
ansible:populate:
taskfile: ./.config/taskfiles/ansible/Taskfile-populate.yml
optional: true
ansible:test:
taskfile: ./.config/taskfiles/ansible/Taskfile-test.yml
optional: true
app:
taskfile: ./.config/taskfiles/app/Taskfile.yml
optional: true
app:virtualbox:
taskfile: ./.config/taskfiles/app/Taskfile-virtualbox.yml
optional: true
boilerplate:
taskfile: ./.config/taskfiles/boilerplate/Taskfile.yml
optional: true
boilerplate:populate:
taskfile: ./.config/taskfiles/boilerplate/Taskfile-populate.yml
optional: true
boilerplate:prompt:
taskfile: ./.config/taskfiles/boilerplate/Taskfile-prompt.yml
optional: true
ci:
taskfile: ./.config/taskfiles/ci/Taskfile.yml
optional: true
ci:github:
taskfile: ./.config/taskfiles/ci/Taskfile-github.yml
optional: true
cloud:
taskfile: ./.config/taskfiles/cloud/Taskfile.yml
optional: true
cloud:cloudflare:
taskfile: ./.config/taskfiles/cloud/Taskfile-cloudflare.yml
optional: true
cloud:dyno:
taskfile: ./.config/taskfiles/cloud/Taskfile-dyno.yml
optional: true
cloud:heroku:
taskfile: ./.config/taskfiles/cloud/Taskfile-heroku.yml
optional: true
cloud:s3:
taskfile: ./.config/taskfiles/cloud/Taskfile-s3.yml
optional: true
common:
taskfile: ./.config/taskfiles/common/Taskfile.yml
optional: true
common:code:
taskfile: ./.config/taskfiles/common/Taskfile-code.yml
optional: true
common:start:
taskfile: ./.config/taskfiles/common/Taskfile-start.yml
optional: true
common:update:
taskfile: ./.config/taskfiles/common/Taskfile-update.yml
optional: true
common:util:
taskfile: ./.config/taskfiles/common/Taskfile-util.yml
optional: true
docker:
taskfile: ./.config/taskfiles/docker/Taskfile.yml
optional: true
docker:build:
taskfile: ./.config/taskfiles/docker/Taskfile-build.yml
optional: true
docker:test:
taskfile: ./.config/taskfiles/docker/Taskfile-test.yml
optional: true
docker:update:
taskfile: ./.config/taskfiles/docker/Taskfile-update.yml
optional: true
dotfiles:
taskfile: ./.config/taskfiles/dotfiles/Taskfile.yml
optional: true
fix:
taskfile: ./.config/taskfiles/fix/Taskfile.yml
optional: true
git:
taskfile: ./.config/taskfiles/git/Taskfile.yml
optional: true
git:bug:
taskfile: ./.config/taskfiles/git/Taskfile-bug.yml
optional: true
git:github:
taskfile: ./.config/taskfiles/git/Taskfile-github.yml
optional: true
git:gitlab:
taskfile: ./.config/taskfiles/git/Taskfile-gitlab.yml
optional: true
git:gitomatic:
taskfile: ./.config/taskfiles/git/Taskfile-gitomatic.yml
optional: true
git:hook:
taskfile: ./.config/taskfiles/git/Taskfile-hook.yml
optional: true
git:issues:
taskfile: ./.config/taskfiles/git/Taskfile-issues.yml
optional: true
go:
taskfile: ./.config/taskfiles/go/Taskfile.yml
optional: true
go:goreleaser:
taskfile: ./.config/taskfiles/go/Taskfile-goreleaser.yml
optional: true
go:test:
taskfile: ./.config/taskfiles/go/Taskfile-test.yml
optional: true
image:
taskfile: ./.config/taskfiles/image/Taskfile.yml
optional: true
install:
taskfile: ./.config/taskfiles/install/Taskfile.yml
optional: true
install:ansible:
taskfile: ./.config/taskfiles/install/Taskfile-ansible.yml
optional: true
install:apt:
taskfile: ./.config/taskfiles/install/Taskfile-apt.yml
optional: true
install:gh:
taskfile: ./.config/taskfiles/install/Taskfile-gh.yml
optional: true
install:github:
taskfile: ./.config/taskfiles/install/Taskfile-github.yml
optional: true
install:go:
taskfile: ./.config/taskfiles/install/Taskfile-go.yml
optional: true
install:npm:
taskfile: ./.config/taskfiles/install/Taskfile-npm.yml
optional: true
install:pipx:
taskfile: ./.config/taskfiles/install/Taskfile-pipx.yml
optional: true
install:python:
taskfile: ./.config/taskfiles/install/Taskfile-python.yml
optional: true
install:qubes:
taskfile: ./.config/taskfiles/install/Taskfile-qubes.yml
optional: true
install:requirements:
taskfile: ./.config/taskfiles/install/Taskfile-requirements.yml
optional: true
install:rust:
taskfile: ./.config/taskfiles/install/Taskfile-rust.yml
optional: true
install:service:
taskfile: ./.config/taskfiles/install/Taskfile-service.yml
optional: true
install:software:
taskfile: ./.config/taskfiles/install/Taskfile-software.yml
optional: true
install:tap:
taskfile: ./.config/taskfiles/install/Taskfile-tap.yml
optional: true
install:ventoy:
taskfile: ./.config/taskfiles/install/Taskfile-ventoy.yml
optional: true
lint:
taskfile: ./.config/taskfiles/lint/Taskfile.yml
optional: true
lint:codeclimate:
taskfile: ./.config/taskfiles/lint/Taskfile-codeclimate.yml
optional: true
lint:esprint:
taskfile: ./.config/taskfiles/lint/Taskfile-esprint.yml
optional: true
lint:markdown:
taskfile: ./.config/taskfiles/lint/Taskfile-markdown.yml
optional: true
lint:prose:
taskfile: ./.config/taskfiles/lint/Taskfile-prose.yml
optional: true
local:
taskfile: ./../../../Taskfile-local.yml
optional: true
log:
optional: true
taskfile: ./.config/taskfiles/log/Taskfile.yml
nest:
taskfile: ./.config/taskfiles/nest/Taskfile.yml
optional: true
npm:
taskfile: ./.config/taskfiles/npm/Taskfile.yml
optional: true
npm:bundle:
taskfile: ./.config/taskfiles/npm/Taskfile-bundle.yml
optional: true
npm:cov:
taskfile: ./.config/taskfiles/npm/Taskfile-cov.yml
optional: true
npm:doc:
taskfile: ./.config/taskfiles/npm/Taskfile-doc.yml
optional: true
packer:
taskfile: ./.config/taskfiles/packer/Taskfile.yml
optional: true
packer:build:
taskfile: ./.config/taskfiles/packer/Taskfile-build.yml
optional: true
packer:update:
taskfile: ./.config/taskfiles/packer/Taskfile-update.yml
optional: true
publish:
taskfile: ./.config/taskfiles/publish/Taskfile.yml
optional: true
publish:android:
taskfile: ./.config/taskfiles/publish/Taskfile-android.yml
optional: true
publish:brew:
taskfile: ./.config/taskfiles/publish/Taskfile-brew.yml
optional: true
publish:chrome:
taskfile: ./.config/taskfiles/publish/Taskfile-chrome.yml
optional: true
publish:firefox:
taskfile: ./.config/taskfiles/publish/Taskfile-firefox.yml
optional: true
publish:ios:
taskfile: ./.config/taskfiles/publish/Taskfile-ios.yml
optional: true
publish:menubar:
taskfile: ./.config/taskfiles/publish/Taskfile-menubar.yml
optional: true
publish:opera:
taskfile: ./.config/taskfiles/publish/Taskfile-opera.yml
optional: true
publish:snap:
taskfile: ./.config/taskfiles/publish/Taskfile-snap.yml
optional: true
python:
taskfile: ./.config/taskfiles/python/Taskfile.yml
optional: true
python:test:
taskfile: ./.config/taskfiles/python/Taskfile-test.yml
optional: true
release:
taskfile: ./.config/taskfiles/release/Taskfile.yml
optional: true
security:
taskfile: ./.config/taskfiles/security/Taskfile.yml
optional: true
security:disk:
taskfile: ./.config/taskfiles/security/Taskfile-disk.yml
optional: true
security:gpg:
taskfile: ./.config/taskfiles/security/Taskfile-gpg.yml
optional: true
security:ssh:
taskfile: ./.config/taskfiles/security/Taskfile-ssh.yml
optional: true
security:yubikey:
taskfile: ./.config/taskfiles/security/Taskfile-yubikey.yml
optional: true
symlink:
taskfile: ./.config/taskfiles/symlink/Taskfile.yml
optional: true
ui:
taskfile: ./.config/taskfiles/ui/Taskfile.yml
optional: true
update:
taskfile: ./.config/taskfiles/update/Taskfile.yml
optional: true
upstream:
taskfile: ./.config/taskfiles/upstream/Taskfile.yml
optional: true
upstream:common:
taskfile: ./.config/taskfiles/upstream/Taskfile-common.yml
optional: true
upstream:commondocs:
taskfile: ./.config/taskfiles/upstream/Taskfile-commondocs.yml
optional: true
upstream:docs:
taskfile: ./.config/taskfiles/upstream/Taskfile-docs.yml
optional: true
upstream:project:
taskfile: ./.config/taskfiles/upstream/Taskfile-project.yml
optional: true
upstream:shared:
taskfile: ./.config/taskfiles/upstream/Taskfile-shared.yml
optional: true
vagrant:
taskfile: ./.config/taskfiles/vagrant/Taskfile.yml
optional: true
vagrant:qubes:
taskfile: ./.config/taskfiles/vagrant/Taskfile-qubes.yml
optional: true
vscode:
taskfile: ./.config/taskfiles/vscode/Taskfile.yml
optional: true
web:
taskfile: ./.config/taskfiles/web/Taskfile.yml
optional: true
web:cloudflare:
taskfile: ./.config/taskfiles/web/Taskfile-cloudflare.yml
optional: true
web:ionic:
taskfile: ./.config/taskfiles/web/Taskfile-ionic.yml
optional: true
web:nx:
taskfile: ./.config/taskfiles/web/Taskfile-nx.yml
optional: true
web:profile:
taskfile: ./.config/taskfiles/web/Taskfile-profile.yml
optional: true
output: interleaved
vars:
DOCKERHUB_PROFILE:
sh: |
if [ -f .config/variables.json ] && type jq &> /dev/null; then
echo "$(jq -r '.profile.dockerhub' .config/variables.json)"
else
echo 'megabytelabs'
fi
DOCKERHUB_USER:
sh: |
if [ -f .config/variables.json ] && type jq &> /dev/null; then
echo "$(jq -r '.profile.dockerHubUser' .config/variables.json)"
else
echo 'ProfessorManhattan'
fi
ESLINT_FIX_RECURSIVE: 'true'
ESLINT_FORMATTER: stylish
ESLINT_FORMATTER_OPTIONS: git-log gitlab pretty summary
GALAXY_AUTHOR: ProfessorManhattan
GALAXY_COMPANY: Megabyte Labs
GALAXY_NAMESPACE:
sh: |
if [ -f meta/main.yml ]; then
grep namespace < meta/main.yml | sed 's/.*namespace: \\(.*\\)$/\\1/g'
else
if [ -f .config/variables.json ] && type jq &> /dev/null; then
echo "$(jq -r '.profile.galaxy' .config/variables.json)"
else
echo 'ProfessorManhattan'
fi
fi
GALAXY_ROLE_NAME:
sh: "if [ -f meta/main.yml ]; then grep role_name < meta/main.yml | sed 's/.*role_name: \\(.*\\)$/\\1/g'; fi"
GITHUB_ORG:
sh: |
if [ -f package.json ] && type jq &> /dev/null && [ "$(jq -r '.blueprint.repository.github' package.json)" != 'null' ]; then
echo "$(jq -r '.blueprint.repository.github' package.json | sed 's/https:\/\/github.com\///' | sed 's/\/.*$//')"
elif [ -f .config/variables.json ] && type jq &> /dev/null; then
echo "$(jq -r '.profile.githubOrg' .config/variables.json)"
else
echo 'megabyte-labs'
fi
GITHUB_USER:
sh: |
if [ -f .config/variables.json ] && type jq &> /dev/null; then
echo "$(jq -r '.profile.github' .config/variables.json)"
else
echo 'ProfessorManhattan'
fi
GROUP_EXEC_ASYNC: 'false'
# yamllint disable rule:line-length
IGNORE_FOLDERS: >-
-path './.autodoc/*' -o -path './.cache/*' -o -path './.common*' -o -path './.config/*' -o -path './.git/*' -o
-path './.modules/*' -o -path './.npm/*' -o
-path './.pnpm-store/*' -o -path './.shared/*' -o -path './.task/*' -o -path './.venv/*' -o -path './.vscode/*' -o
-path './build/*' -o -path './dist/*' -o -path './node_modules/*' -o -path './roles/*' -o -name pnpm-lock.yaml -o
-name package-lock.json -o -name poetry.lock -o -name '.variables.json' -o -name '.git'
INIT_SCRIPT: https://gitlab.com/megabyte-labs/gitlab-ci/-/raw/master/scripts/update-init.sh
LOG_FIX:
sh: chmod +x .config/log
MODEL_TASKFILE: https://gitlab.com/megabyte-labs/common/shared/-/raw/master/Taskfile.yml
NPM_KEEP_UPDATED: ''
NPM_PROGRAM: pnpm
PROJECT_TYPE:
sh: |
if type jq &> /dev/null && [ -f package.json ]; then VER="$(jq -r '.blueprint.group' package.json)"; if [ "$VER" == 'null' ]; then TYPE="$GROUP_TYPE"; else TYPE="$VER"; fi; else TYPE="$GROUP_TYPE"; fi
if type jq &> /dev/null && [ -f package.json ]; then VER="$(jq -r '.blueprint.subgroup' package.json)"; if [ "$VER" == 'null' ]; then SUBTYPE="$REPOSITORY_TYPE"; else SUBTYPE="$VER"; fi; else SUBTYPE="$REPOSITORY_TYPE"; fi
if [ "$TYPE" == 'common' ] && [ "$SUBTYPE" == 'shared' ]; then
echo 'shared'
elif [ "$TYPE" == 'common' ]; then
echo 'common'
elif [ "$TYPE" == 'documentation' ] && [ "$SUBTYPE" == 'shared' ]; then
echo 'commondocs'
elif [ "$TYPE" == 'documentation' ]; then
echo 'docs'
else
echo 'project'
fi
# yamllint enable rule:line-length
PYTHON_HANDLE:
sh: |
if type poetry &> /dev/null; then
echo 'poetry run '
else
echo ''
fi
PYTHON_VIRTUALENV: true
REPOSITORY_SUBTYPE:
sh: |
if [ -n "$REPOSITORY_TYPE" ]; then REPO_SUBTYPE="$REPOSITORY_TYPE"; fi
if type jq &> /dev/null && [ -f package.json ]; then
VER="$(jq -r '.blueprint.subgroup' package.json)"
if [ "$VER" == 'null' ]; then
if [ -n "$REPO_SUBTYPE" ]; then echo "$REPO_SUBTYPE"; else echo "misc"; fi
else
echo "$VER"
fi
else
if [ -n "$REPO_SUBTYPE" ]; then echo "$REPO_SUBTYPE"; else echo "misc"; fi
fi
REPOSITORY_TYPE:
sh: |
if [ -n "$GROUP_TYPE" ]; then REPO_TYPE="$GROUP_TYPE"; fi
if type jq &> /dev/null && [ -f package.json ]; then
VER="$(jq -r '.blueprint.group' package.json)"
if [ "$VER" == 'null' ]; then
if [ -n "$REPO_TYPE" ]; then echo "$REPO_TYPE"; else echo "misc"; fi
else
echo "$VER"
fi
else
if [ -n "$REPO_TYPE" ]; then echo "$REPO_TYPE"; else echo "misc"; fi
fi
SEMANTIC_CONFIG: semantic-release-config
TIMEZONE: America/New_York
env:
GOPATH:
sh: |
if [ -z "$GOPATH" ]; then
echo "$HOME/.local/go"
else
echo "$GOPATH"
fi
OSTYPE:
sh: |
{{if (eq OS "linux")}}LINUX_FLAVOR='linux-gnu'
LIBC=$(ldd /bin/ls | grep 'musl' | head -1 | cut -d ' ' -f1)
if [ -n "$LIBC" ]; then LINUX_FLAVOR='linux-musl'; fi{{end}}
echo "{{if (eq OS "linux")}}$LINUX_FLAVOR{{else}}darwin{{end}}"
PATH:
sh: |
PATH="$PATH:$HOME/.local/bin:$HOME/.poetry/bin:$HOME/.gem/bin:$HOME/.asdf/bin"
PATH="$PATH:$HOME/.local/go/bin:$HOME/go/bin"
PATH="$PATH:/home/linuxbrew/.linuxbrew/bin:/home/linuxbrew/.linuxbrew/sbin"
PATH="$PATH:$PWD/bin"
PATH="$PATH:$HOME/.volta/bin"
echo "$PATH"
RECORD_INSTALL:
sh: if [ -n "$CI" ]; then echo 'true'; fi
SENTRY_DSN:
sh: |
if type jq &> /dev/null; then
DSN="$(jq -r '.blueprint.sentryDSN' package.json)"
if [ "$DSN" != 'null' ]; then echo "$DSN"; fi
fi
VOLTA_HOME:
sh: echo "$HOME/.volta"
profile: |
if [[ "$OSTYPE" == 'linux-gnu'* ]] || [[ "$OSTYPE" == 'linux-musl'* ]]; then
if [ -f /home/linuxbrew/.linuxbrew/bin/brew ] && ! type brew > /dev/null; then
eval "$(/home/linuxbrew/.linuxbrew/bin/brew shellenv)"
fi
fi
if [[ "$OSTYPE" == 'darwin'* ]] && type brew > /dev/null; then
BREW_PREFIX="$(brew --prefix)"
PATH="$PATH:$BREW_PREFIX/opt/coreutils/libexec/gnubin"
PATH="$PATH:$BREW_PREFIX/opt/findutils/libexec/gnubin"
PATH="$PATH:$BREW_PREFIX/opt/gnu-sed/libexec/gnubin"
PATH="$PATH:$BREW_PREFIX/opt/grep/libexec/gnubin"
PATH="$PATH:$BREW_PREFIX/opt/gnu-tar/libexec/gnubin"
PATH="$PATH:$BREW_PREFIX/opt/gawk/libexec/gnubin"
fi
if [ -f .venv/bin/activate ]; then
. .venv/bin/activate
fi
tasks:
build:
deps:
- install:software:jq
- install:software:node
desc: Build the project using the build script defined in `package.json`
summary: |
# Build the Project
Use this command to build the project. It executes the command defined
in `package.json` under the `.scripts.build` key.
vars:
NONINTERACTIVE_MISSING_BUILD_CMD: There must be a build command under `.scripts.build` in `package.json`!
log:
error: Encountered error while running `npm run build`
start: Running `npm run build`
success: Successfully ran `npm run build`
cmds:
- |
if [ "$(jq '.scripts.build' package.json)" != 'null' ]; then
if type npm &> /dev/null; then
npm run build
else
task {{.REPOSITORY_TYPE}}:build
fi
else
[[ $- == *i* ]] && task prepare || (.config/log error '{{.NONINTERACTIVE_MISSING_BUILD_CMD}}' && exit 1)
fi
clean:
desc: Removes optional folders that are cached during various tasks
summary: |
# Clean Project / Remove Optional Directories and Files
This task will remove all the unnecessary files that are downloaded, generated, and
cached during various build steps. This task is used by the `reset` task
which will re-generate the project from scratch. Ideally, this task and the reset task
should never be necessary. The `start` task should be used instead.
vars:
CLEAN_TARGETS: .autodoc .cache .task .venv node_modules tsconfig.tsbuildinfo venv
.variables.json
cmds:
- task: common:clean
vars:
CLEAN_TARGETS: '{{.CLEAN_TARGETS}}'
commit:
desc: Lint staged files, report spelling errors, and open a _required_ commit dialoge
summary: |
# Commit Code
This task will perform linting and auto-fixing on the files that have been staged in
git (i.e. the files that were added with `git add --all`). It will then report possible
spelling errors that you may choose to fix. Then, it opens a _required_ interactive commit
questionnaire that will help you make better commits that are compatible with software
that generates the CHANGELOG.md.
It is very important that you use this task to commit rather than the conventional approach
using `git commit -m`. However, if you really need to, you can add the flag `--no-verify`
to your regular `git commit -m` command to bypass the pre-commit hook.
cmds:
- task: common:commit
commit:all:
deps:
- install:software:git
desc: Add all the untracked changes and commit the code
summary: |
# Commit All Untracked Code
By default, this task is an alias for:
```
git add --all
git commit
```
If you pass a commit message as a CLI argument, then the pre-commit
logic will be bypassed. By bypassing the hooks, the commit message will be
excluded from the automatic CHANGELOG.md entry generated during commits.
Passing the commit message as a CLI argument can be done like so:
```
task commit -- "Added new files that do not need to show up in CHANGELOG.md"
```
log:
error: Error while running commit logic
start: Adding all changes and committing
success: Successfully commit changes
cmds:
- |
{{if .CLI_ARGS}}
task --list > /dev/null || (echo "ERROR: Invalid Taskfiles!" && exit 1)
git add --all
HUSKY=0 git commit -m "{{.CLI_ARGS}}" --no-verify
{{else}}
task --list > /dev/null || (echo "ERROR: Invalid Taskfiles!" && exit 1)
git add --all
git commit
{{end}}
commit:quick:
deps:
- ci:commit:config
cmds:
- |
task --list > /dev/null || (echo "ERROR: Invalid Taskfiles!" && exit 1)
git add --all
- |
.config/log info 'Bypassing git hooks for git commit'
HUSKY=0 git commit -m "🔧 chore(tweak): quick minor update" --no-verify
- git push origin master
devcontainer:
deps:
- install:npm:devcontainer
- install:software:docker
donothing: 'true'
fix:
desc: Run code auto-fixers / auto-formatters
summary: |
# Auto-Fix / Auto-Format Code
This task will automatically apply lint fixes across the whole project using
auto-fixers. Although unlikely, it is possible that auto-fixing can introduce
an error so the auto-fixes still have to be validated.
cmds:
- task: fix:all
fresh:
summary: Initialize a new project with only the Taskfile.yml present
cmds:
- curl -sSL https://gitlab.com/megabyte-labs/common/shared/-/raw/master/common/start.sh > start.sh
- curl -sSL https://gitlab.com/megabyte-labs/common/shared/-/blob/master/common/.gitignore > .gitignore
- curl -sSL https://gitlab.com/megabyte-labs/common/shared/-/blob/master/common/.editorconfig > .editorconfig
- curl -sSL https://gitlab.com/megabyte-labs/common/shared/-/blob/master/package.json > package.json
- curl -sSL https://gitlab.com/megabyte-labs/common/shared/-/blob/master/.gitlab-ci.yml > .gitlab-ci.yml
- TMP="$(mktemp)" && jq -r 'del(.blueprint)' package.json > "$TMP" && mv "$TMP" package.json
- bash start.sh
- task: prepare
get:links:
deps:
- install:software:jq
desc: Log useful links such as the current project's git repository link
vars:
GITHUB_URL:
sh: jq -r '.blueprint.repository.github' package.json
GITLAB_URL:
sh: jq -r '.blueprint.repository.gitlab' package.json
cmds:
- .config/log info 'GitHub -----> `{{.GITHUB_URL}}`'
- .config/log info 'GitLab -----> `{{.GITLAB_URL}}`'
group:exec:
desc: Execute group commands on any GitLab group (including repositories in sub-groups)
summary: |
# Run Commands on Multiple GitLab Repositories
This command requires that the `GITLAB_TOKEN` environment variable be set. With the
token defined, you can use this task to run scripts on repositories that fall under
any given group or sub-group. By default, it runs the script(s) on all the
repositories in the specified group and sub-groups.
You can use this task to perform adhoc bulk changes to large numbers of
repositories that are hosted on GitLab.
**Example usage:**
`task group:exec -- group/subgroup ---- 'bash <(curl https://myscript.com)'
In the example above, the bash command will be run in the root of each repository.
Be sure to wrap the command in quotes or you might observe some odd behavior.
cmds:
- task: git:gitlab:group:exec
init:
deps:
- install:software:jq
- install:software:yq
desc: Runs the initialization script
summary: |
# Initialize the Project
This command will mostly not be needed for pre-existing projects. This task:
1. Migrates legacy projects
2. Fixes common errors
3. Ensures the project is initialized
4. Prompts for missing metadata
5. Runs the `start` task
If you are facing difficulties, you can try running this task to reset the project,
perform common fixes, and run the whole start up routine.
## Using a Custom Initialization Script
You can control the initialization script that this task runs by specifying
`UPDATE_INIT_SCRIPT` as an environment variable. If it is not specified, then this
task runs the [default script]({{.INIT_SCRIPT}}).
log:
error: Failed to run initialization script
start: Initializing project by running initialization script
success: Successfully bootstrapped project by running initialization script
cmds:
- git init
- task: repair
- task: prepare
jumpusb:
desc: Creates a JumpUSB (https://jumpusb.com)
cmds:
- task: install:ventoy
lint:
desc: Lints the project using all linters
summary: |
# Lint the Project Using Most of the Linters
This task will do a project-wide linting using all of the linters that commonly
report errors. You can use this task to spot linting errors prior to running
the git pre-commit hooks.
**Example usage:**
`task lint`
cmds:
- task: lint:all
livereload:
deps:
- install:npm:nodemon
desc: Start the project with live-reloading (i.e. watch mode)
summary: |
# LiveReload the Project
Using LiveReload, you can automatically run the project any time you make
changes to the project. The LiveReload feature uses [nodemon](https://github.com/remy/nodemon)
with the configuration stored in `.config/nodemon.json`.
Whenever you make a change to the project, `task project:livereload` will run. You can
define the command that runs every time you make a change in the `Taskfile-project.yml`
`livereload` section. This file is kept intact even across upstream propagation updates,
unlike the regular `Taskfile.yml`.
**Example usage:**
`task livereload`
The default configuration (in `.config/nodemon.json`) is generic and makes assumptions
about the file types to watch based on what type project it is. If you would like to
use a different configuration, you can pass in the location of the configuration like so:
**Example with custom configuration:**
`task livereload -- nodemon.custom.json`
The task program also provides a `--watch` feature. However, it relies on the `sources` attribute
being defined so it might not work in all cases.
**Example using `task --watch`:**
`task --watch mytask`
log:
start: Starting `nodemon` live-reload session
cmds:
- |
if [ ! -f Taskfile-project.yml ]; then
.config/log error '`Taskfile-project.yml` must exist and have a `livereload` task to use with `nodemon`' && exit 1
fi
- nodemon --config {{if .CLI_ARGS}}{{.CLI_ARGS}}{{else}}.config/nodemon.json{{end}}
new:project:
desc: Create a new project
cmds:
- task: prepare
preload:
desc: Set up your workstation in advance by installing commonly used programs
summary: |
# Speed Up Future Development by Preloading Common System Applications
Just about every development task requires some sort of globally installed
application. TypeScript requires Node.js to be installed. Ansible requires
a handful of CLIs (and Python). This task will check for missing applications
and install them globally. If you do not run this task, the routines will
assume you want to keep the footprint small and use disposable virtual
environments whenever possible (i.e. `{{.NPX_PACKAGE}}` in the case of Node.js,
`poetry` in the case of Python, etc.).
## Reboot Requirements
Some software that is installed, like VirtualBox and Docker, require reboots so
it is recommended that you reboot after running this task.
## Passwordless Installation
This installation method and all the methods we use will only prompt for a sudo
password when absolutely necessary. If you already have common development tools
it is possible that you will not even have to enter a sudo password. This is
accomplished by installing to `$HOME/.local/bin` whenever a traditionally system
level binary is installed. However, if you are missing something like git, then
chances are you will be asked for a sudo password. In this case, we recommend
you adopt the Megabyte Labs philosophy and inspect the code before running it.
log:
error: Encountered error while preloading system with common dependencies (REBOOT RECOMMENDED)
start: Preloading system with common dependencies
success: Successfully preloaded system with common dependencies (REBOOT RECOMMENDED)
cmds:
- task: install:software:common
- task: install:brewfile
- task: install:extras
- task: install:go:bundle
- task: install:rust:bundle
- task: install:github:bundle
- task: install:npm:bundle
- task: install:pipx:bundle
- task: install:python:requirements
- task: install:modules:local
prepare:
desc: Prepares the project for the normal start command
summary: |
# Prepare the Project
This task ensures the project has all the required metadata. If a project
is missing required metadata then this task will interactively prompt the user
for the missing data. It also performs miscellaneous tasks that are sometimes
required by the `start` task.
log:
error: Encountered error while preparing the project
start: Preparing the project
success: Successfully prepared the project
cmds:
- task: boilerplate:check:package
- task: boilerplate:clean
publish:
desc: Publish a semantic release via `semantic-release`
summary: |
# Publish the Project
Using this task, you can publish a project to all its targets. The targets
depend on the project type. Most projects will include:
1. Updating version numbers in `package.json`, `pyproject.toml`, etc.
2. Adding a new git tag at the version and publishing it with updated assets
3. Publishing repository-specific items like NPM packages, PyPi packages, etc.
4. Publishing artifacts to GitLab Releases and GitHub Releases
5. Updating the `docs/CHANGELOG.md`
## Packages Used
This task runs `semantic-release` using the `semantic-release-config` package. The package
includes release instructions for:
1. Python packages
2. NPM packages
3. Dockerfile projects
4. Go projects
5. Ansible roles
## Formats
It does its best to ship projects out in as many formats (that make sense) as possible.
For instance, an NPM CLI gets published as:
1. NPM package
2. Binaries (including deb and rpm) available on GitHub/GitLab releases
3. Brew formulae
4. Snapcraft
5. Probably more implemented after writing this
## Python Package Notes
If `setup.cfg` is present, then the project is assumed to be a legacy Python
project that needs to run in environment with access to the `python-semantic`
extras defined in `pyproject.toml`.
log:
error: Error running `semantic-release` via `task publish`
start: Running `semantic-release` via `task publish`
success: Successfully ran `semantic-release` via `task publish`
cmds:
- task: publish:semantic-release
publish:force:
desc: Force a `semantic-release` even if there are no new eligible commits
summary: |
# Force a Release with Empty Commit
Trigger any kind of version bump / semantic release by passing
`PATCH UPDATE`, `MINOR UPDATE`, or `MAJOR UPDATE` in via CLI arguments.
This task will commit an empty commit message that will trigger the
corresponding version bump type.
**Example of patch update:**
`task publish:force -- 'PATCH UPDATE'`
**Example of minor update:**
`task publish:force -- 'MINOR UPDATE'`
**Example of major update:**
`task publish:force -- 'MAJOR UPDATE'`
vars:
UPDATE_LEVEL: '{{if .CLI_ARGS}}{{.CLI_ARGS}}{{else}}PATCH UPDATE{{end}}'
log:
error: Error creating update via `task publish:force`
start: Publishing `semantic-release` update via `task publish:force`
success: Successfully published update via `task publish:force`
cmds:
- |
.config/log info 'Bypassing git hooks for git commit'
HUSKY=0 git commit -a --allow-empty -m '🔨 chore(bump): Forced semantic-release {{.UPDATE_LEVEL}}' --no-verify
- task: publish
pull:upstream:
desc: Pull from upstream repositories
summary: |
# Pull Changes from Upstream Repositories
This task will do a `git pull` on each repository defined in `.blueprint.upstreamRemotes`.
The variable should be an array of objects where each object has the `remote`, `url`, and `branch` keys.
**Sample value of `.blueprint.upstreamRemotes`:**
`[{ "remote": "ionic", "url": "git@github.com:ionic-team/ionic-docs.git", "branch": "main" }]`
log:
error: Encountered error while running `git pull` on each of the `upstreamRemotes`
start: Running `git pull` on each of the `upstreamRemotes`
success: Successfully pulled from `upstreamRemotes`
cmds:
- task: common:update:upstream:remotes:pull
repair:
cmds:
- task: common:repair
- |
TMP="$(mktemp)"
if [ -n "$UPDATE_INIT_SCRIPT" ]; then
curl -sSL "$UPDATE_INIT_SCRIPT" > "$TMP" && bash "$TMP" && rm "$TMP"
else
curl -sSL {{.INIT_SCRIPT}} > "$TMP" && bash "$TMP" && rm "$TMP"
fi
reset:
desc: Resets the project by removing all caches and then re-generating templated files
summary: |
# Reset Project and Re-Generate Assets
This task is intended to be used when there appear to be cache related issues.
It will first clean the project by removing common local libraries like `node_modules/`
and the `.cache/` folder, to name a couple. Then, without acquiring any upstream
updates, it re-generates any templated files.
cmds:
- task: common:reset
reset:force:
desc: 'Aggressively reset the project (**WARNING** This will wipe uncommitted work)'
summary: |
# Aggressively Reset Project
This task will completely wipe the project by:
1. Resetting to the HEAD
2. Removing all files that are not included in source control (i.e. `node_modules/` etc.)
3. Pulling the latest changes from `master`
This task is essentially the equivalent of deleteing the project and re-cloning it.
prompt:
type: confirm
message: Are you sure you want to forcefully reset the project?
answer:
cmds:
- task: common:reset:force
scripts:
interactive: true
deps:
- install:npm:ntl
desc: Run and view descriptions for `npm scripts` via an interactive dialog
summary: |
# Interactively Select Scripts Defined in package.json
Our projects use `run` (a fork of task) to handle most of the task running.
However, in some projects there may be scripts defined in package.json. This
task is a convenience method that will present a list of scripts alongside
their descriptions that you can interactively launch.
log:
error: Error running `NTL_RUNNER={{.NPM_PROGRAM}} ntl`
start: Running `NTL_RUNNER={{.NPM_PROGRAM}} ntl`
cmds:
- NTL_RUNNER={{.NPM_PROGRAM}} ntl
services:
desc: Update elements of the repository that require API access
summary: |
# Update Elements of the Repository that Require API Access
This task will ensure that the git repositories and other services related to the
project are updated with the proper configurations. It requires that certain
API keys be set. Generally, only project owners will use this task.
cmds:
- task: common:update:services
status:
- '[ -n "$GITLAB_CI" ] && [ "$REPOSITORY_UPDATE" != "true" ]'
shell:
desc: Start a terminal session using Docker with any Linux operating system
compile: |
'.tasks.common.shell = $this' common/Taskfile.yml
summary: |
# Start a Docker Terminal Session
Use Docker to run commands on nearly any operating system. The operating
systems are all stock distros with systemd added.
The selected environment will mount the current working directory to the