/
Makefile
795 lines (625 loc) · 26.7 KB
/
Makefile
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
# GNU Make tips:
# Variables:
# $@ The file name of the target of the rule
d_c := sudo docker-compose
d_c_logs := $(d_c) logs --no-color
d_c_logs_f0 := $(d_c) logs --no-color -f --tail 0
# [magic_make_craziness]
# When in nix-shell, if running `s/tyd u`, then, when s/tyd.ts does
# `tyu.spawnInForeground('make debug_asset_bundles')` and thus calls
# the debug_asset_bundles target — then, when building e.g.:
# images/web/assets/talkyard-comments.js.gz,
# then this:
# s/d-gulp compileBlogCommentsTypescript-concatScripts
# fails, with the error:
#
# > s/d-gulp compileBlogCommentsTypescript-concatScripts
# > make: s/d-gulp: No such file or directory
#
# But if doing *anything* more than just calling s/d-gulp, then,
# magically works fine! For example, all these works:
#
# s/d-gulp compileBlogCommentsTypescript-concatScripts && echo pointleeeesss01
# s/d-gulp compileBlogCommentsTypescript-concatScripts ; echo pointleeeesss01
# echo pointleeeesss02 && s/d-gulp compileBlogCommentsTypescript-concatScripts
# echo pointleeeesss02 ; s/d-gulp compileBlogCommentsTypescript-concatScripts
#
# Note that there's just '&&' or ';' and a pointless echo-nothing command.
# No idea why s/d-gulp isn't found, but echo sth && s/d-gulp works.
# But why bother finding out what's happening?
# Let's just use this d_c_nodejs_gulp macro instead:
#
d_c_nodejs_gulp := $(d_c) run --rm nodejs gulp
# This needs: apt install inotify-tools
# Background?:
# @(echo "bg cmd" ; (echo "bg_cmd exited, status: $$?")) & backsl
# But then continues running also after other foreground target completed.
#
# Supposedly works on Mac:
# brew install fswatch
# and instead of the inotifywait line:
# fswatch -1 .
# or?: Nodejs nodemon?
# see: https://stackoverflow.com/a/23734495
#
# Listening to modify, delete, move, create seems better than close_write?
# close_write doesn't necessarily mean the file was modified.
#
# Have inotifywait exit after a few seconds, because otherwise it tends to stay
# alive forever, after the parent 'while true; do ...' has
# exited.
# Hmm! But then make runs again and logs annoying messages. Skip: --timeout 3
#
watch: watch-debug_asset_bundles
watch-debug_asset_bundles:
while true; do \
inotifywait -q -r -e modify -e create -e delete -e move \
client package.json ;\
make debug_asset_bundles ;\
done
# E.g. make watch what=target
watch-what:
while true; do \
make $(what); \
inotifywait -qre close_write . ;\
done
.PHONY: \
clean \
dev-images \
prod-images \
build \
up \
down \
dead \
prod_asset_bundles \
prod_asset_bundle_files \
debug_asset_bundles \
debug_asset_bundles_files \
git-subm-init-upd \
node_modules \
to-talkyard \
e2e_node_modules \
e2e_wdio6_node_modules \
e2e_wdio7_node_modules \
play-cli \
watch \
watch-debug_asset_bundles
.DEFAULT_GOAL := print_help
print_help:
@echo
@echo "This is Talkyard's Makefile."
@echo
@echo "(How do you debug a Makefile, when it does weird things?"
@echo "Like so: make -nd the_target e.g.: make -nd up"
@echo "And to show only interesting things like commands: (not indented)"
@echo "make -nd debug_asset_bundles | grep -v 'older than' | egrep -i -C2 '^[^ ]|newer than|does not exist|must remake'"
@echo ")"
@echo
@echo "Usage:"
@echo
@echo "Building production images"
@echo "--------------------------"
@echo
@echo "Edit version.txt and commit. Edit DOCKER_REPOSITORY in .env."
@echo "Then:"
@echo
@echo " Build production images: make prod-images"
@echo " Push to your repo: make tag-and-push-latest-images"
@echo
@echo "Running a development server"
@echo "--------------------------"
@echo
@echo "Use the script s/tyd instead of make, e.g.: s/tyd up"
@echo "Type s/tyd help to find out more."
@echo
@echo "What more do you want to know? Talk with us at"
@echo "https://forum.talkyard.io."
@echo
DOCKER_REPOSITORY := \
$(shell sed -nr 's/^DOCKER_REPOSITORY=([a-zA-Z0-9\._-]*).*/\1/p' .env)
# All new builds go into the -dev channel first, and might later get promoted to
# the -rapid, -regular and -stable channels.
# (Currently there's only -dev and -regular though.)
DEV_RELEASE_CHANNEL := tyse-v0-dev
DEV_RELEASE_CHANNEL_SUFFIX := dev
TALKYARD_VERSION := \
$(shell cat version.txt)
define ask_for_root_password
sudo echo
endef
# ----- Git submodules
# This'll be all Git submodule directories. If some are missing, need to git-clone them.
git_modules := \
$(shell grep submodule .gitmodules | egrep -v '^ *\#' | sed -r 's/^.submodule "([^"]+).*$$/\1\/.git/')
git-subm-init-upd: $(git_modules)
# Ooops if you try to add a new node_modules commit, then this easily resets it
# and you'll need to try again. [make_downgrades_node_mods]
$(git_modules): $@
git submodule update --init
# ----- E2E test dependencies
e2e_node_modules: \
e2e_wdio6_node_modules \
e2e_wdio7_node_modules
# Old Webdriverio 6 test dependencies. [wdio_6_to_7]
e2e_wdio6_node_modules: \
tests/e2e/node_modules/.bin/wdio
tests/e2e/node_modules/.bin/wdio:
cd tests/e2e && yarn
# Webdriverio 7 test dependencies.
e2e_wdio7_node_modules: \
tests/e2e-wdio7/node_modules/.bin/wdio
tests/e2e-wdio7/node_modules/.bin/wdio:
cd tests/e2e-wdio7 && yarn
# ----- Javascript and CSS bundles
# App server, client, build scripts dependencies.
# If these are present, probably all js modules have been installed?
node_modules: \
node_modules/.bin/ts-node
node_modules/.bin/ts-node:
s/yarn
# BUG RISK sync with Gulp so won't accidentally forget to (re)build? [GZPATHS]
# Sync with the languages in module ty-translations. [5JUKQR2]
# public/res/2d-bundle.min.js.gz // [SLIMTYPE]
prod_asset_bundle_files:=\
images/web/assets/talkyard-comments.min.js.gz \
images/web/assets/talkyard-service-worker.min.js.gz \
images/web/assets/$(TALKYARD_VERSION)/editor-bundle.min.js.gz \
images/web/assets/$(TALKYARD_VERSION)/more-bundle.min.js.gz \
images/web/assets/$(TALKYARD_VERSION)/slim-bundle.min.js.gz \
images/web/assets/$(TALKYARD_VERSION)/staff-bundle.min.js.gz \
images/web/assets/$(TALKYARD_VERSION)/styles-bundle.min.css.gz \
images/web/assets/$(TALKYARD_VERSION)/styles-bundle.rtl.css.gz \
images/web/assets/$(TALKYARD_VERSION)/styles-bundle.rtl.min.css.gz \
images/web/assets/$(TALKYARD_VERSION)/zxcvbn.min.js.gz \
images/web/assets/$(TALKYARD_VERSION)/translations/de_DE/i18n.js.gz \
images/web/assets/$(TALKYARD_VERSION)/translations/de_DE/i18n.min.js.gz \
images/web/assets/$(TALKYARD_VERSION)/translations/en_US/i18n.js.gz \
images/web/assets/$(TALKYARD_VERSION)/translations/en_US/i18n.min.js.gz \
images/web/assets/$(TALKYARD_VERSION)/translations/es_CL/i18n.js.gz \
images/web/assets/$(TALKYARD_VERSION)/translations/es_CL/i18n.min.js.gz \
images/web/assets/$(TALKYARD_VERSION)/translations/he_IL/i18n.js.gz \
images/web/assets/$(TALKYARD_VERSION)/translations/he_IL/i18n.min.js.gz \
images/web/assets/$(TALKYARD_VERSION)/translations/lv_LV/i18n.js.gz \
images/web/assets/$(TALKYARD_VERSION)/translations/lv_LV/i18n.min.js.gz \
images/web/assets/$(TALKYARD_VERSION)/translations/pl_PL/i18n.js.gz \
images/web/assets/$(TALKYARD_VERSION)/translations/pl_PL/i18n.min.js.gz \
images/web/assets/$(TALKYARD_VERSION)/translations/pt_BR/i18n.js.gz \
images/web/assets/$(TALKYARD_VERSION)/translations/pt_BR/i18n.min.js.gz \
images/web/assets/$(TALKYARD_VERSION)/translations/ru_RU/i18n.js.gz \
images/web/assets/$(TALKYARD_VERSION)/translations/ru_RU/i18n.min.js.gz \
images/web/assets/$(TALKYARD_VERSION)/translations/sv_SE/i18n.js.gz \
images/web/assets/$(TALKYARD_VERSION)/translations/sv_SE/i18n.min.js.gz \
images/web/assets/$(TALKYARD_VERSION)/translations/uk_UA/i18n.js.gz \
images/web/assets/$(TALKYARD_VERSION)/translations/uk_UA/i18n.min.js.gz \
images/web/assets/$(TALKYARD_VERSION)/translations/zh_CN/i18n.js.gz \
images/web/assets/$(TALKYARD_VERSION)/translations/zh_CN/i18n.min.js.gz \
images/app/assets/server-bundle.min.js \
images/app/assets/translations/de_DE/i18n.min.js \
images/app/assets/translations/en_US/i18n.min.js \
images/app/assets/translations/es_CL/i18n.min.js \
images/app/assets/translations/he_IL/i18n.min.js \
images/app/assets/translations/lv_LV/i18n.min.js \
images/app/assets/translations/pl_PL/i18n.min.js \
images/app/assets/translations/pt_BR/i18n.min.js \
images/app/assets/translations/ru_RU/i18n.min.js \
images/app/assets/translations/sv_SE/i18n.min.js \
images/app/assets/translations/uk_UA/i18n.min.js \
images/app/assets/translations/zh_CN/i18n.min.js
# Sync this task name w e2e test [MKBUNDLS].
prod_asset_bundles: debug_asset_bundles $(prod_asset_bundle_files)
$(prod_asset_bundle_files): $@
$(d_c_nodejs_gulp) build_release_dont_clean_before
# Use .js.gz, because .js files get deleted (aren't needed). [UNCOMPRAST]
# Except for the server bundle — it loads non-gz scripts.
debug_asset_bundles_files: \
images/app/assets/server-bundle.js \
images/web/assets/talkyard-comments.js.gz \
images/web/assets/talkyard-service-worker.js.gz \
images/web/assets/$(TALKYARD_VERSION)/editor-bundle.js.gz \
images/web/assets/$(TALKYARD_VERSION)/head-bundle.js.gz \
images/web/assets/$(TALKYARD_VERSION)/more-bundle.js.gz \
images/web/assets/$(TALKYARD_VERSION)/slim-bundle.js.gz \
images/web/assets/$(TALKYARD_VERSION)/staff-bundle.js.gz \
images/web/assets/$(TALKYARD_VERSION)/zxcvbn.js.gz \
images/web/assets/$(TALKYARD_VERSION)/styles-bundle.css.gz
# Most files in client/app-slim are softlinked from client/server/*,
# so regenerate bundle also if any app-slim file changes. Plus some
# specific third-party and node_modules files.
#
# Sync with gulpfile.ts [srv_js_files] — if this list gets out of sync,
# Prod builds will still work fine since they clean and rebuild-all,
# but Dev builds might get a messed up server side bundle, causing React.js
# hydration errors, making "impossible" things happen and break in the browser.
#
# It's annoying to have too keep things in sync between here and gulpfile.js
# — what are some better alternatives?
#
# Doesn't work: $(shell find client/{app-slim,server}/ — so 2 lines instead.
#
images/app/assets/server-bundle.js: \
$(shell find client/app-slim/ -type f \( -name '*.ts' -o -name '*.js' \)) \
$(shell find client/server/ -type f \( -name '*.ts' -o -name '*.js' \)) \
client/types-and-const-enums.ts \
modules/sanitize-html/dist/sanitize-html.min.js \
client/third-party/html-css-sanitizer-bundle.js \
node_modules/react/umd/react.production.min.js \
node_modules/react-dom/umd/react-dom-server.browser.production.min.js \
node_modules/react-dom-factories/index.js \
node_modules/create-react-class/create-react-class.min.js \
node_modules/react-router-dom/umd/react-router-dom.min.js \
client/third-party/tiny-querystring.umd.js \
node_modules/markdown-it/dist/markdown-it.min.js \
client/third-party/lodash-custom.js \
client/third-party/non-angular-slugify.js \
client/app-editor/editor/mentions-markdown-it-plugin.ts \
client/app-editor/editor/link-previews-markdown-it-plugin.editor.ts
@echo "\nRegenerating: $@ ..."
$(d_c_nodejs_gulp) compileServerTypescriptConcatJavascript
# Sync w gulpfile.js [embcmts_js_files]
images/web/assets/talkyard-comments.js.gz: \
$(shell find client/embedded-comments/ -type f \( -name '*.ts' -o -name '*.js' \)) \
client/types-and-const-enums.ts \
client/third-party/bliss.shy.js \
client/third-party/smoothscroll-tiny.js \
client/app-slim/utils/calcScrollRectIntoViewCoords.js
@echo "\nRegenerating: $@ ..."
$(d_c_nodejs_gulp) compileBlogCommentsTypescript-concatScripts
@# [magic_make_craziness]
## This won't work if running Make from inside nix-shell; s/d-gulp then isn't found:
# s/d-gulp compileBlogCommentsTypescript-concatScripts
## But these work fine: (it's the same! Just 'echo .. ;' and 'echo .. &&')
# echo pointless ; s/d-gulp compileBlogCommentsTypescript-concatScripts
# echo pointless && s/d-gulp compileBlogCommentsTypescript-concatScripts
# Sync w gulpfile.js. [sw_js_files]
images/web/assets/talkyard-service-worker.js.gz: \
$(shell find client/serviceworker/ -type f \( -name '*.ts' -o -name '*.js' \)) \
client/types-and-const-enums.ts
@echo "\nRegenerating: $@ ..."
$(d_c_nodejs_gulp) compileSwTypescript-concatScripts
# Sync w gulpfile.js. [edr_js_files]
images/web/assets/$(TALKYARD_VERSION)/editor-bundle.js.gz: \
$(shell find client/app-editor/ -type f \( -name '*.ts' -o -name '*.js' \)) \
client/types-and-const-enums.ts \
modules/sanitize-html/dist/sanitize-html.js \
client/third-party/html-css-sanitizer-bundle.js \
node_modules/markdown-it/dist/markdown-it.js \
node_modules/blacklist/dist/blacklist.js \
node_modules/fileapi/dist/FileAPI.html5.js \
node_modules/@webscopeio/react-textarea-autocomplete/dist/react-textarea-autocomplete.umd.min.js \
client/third-party/diff_match_patch.js \
client/third-party/non-angular-slugify.js
@echo "\nRegenerating: $@ ..."
$(d_c_nodejs_gulp) compileEditorTypescript-concatScripts
# Sync w gulpfile.js. [head_js_files]
images/web/assets/$(TALKYARD_VERSION)/head-bundle.js.gz: \
$(shell find client/app-head/ -type f \( -name '*.ts' -o -name '*.js' \)) \
client/types-and-const-enums.ts
@echo "\nRegenerating: $@ ..."
$(d_c_nodejs_gulp) compileHeadTypescript-concatScripts
# Sync with gulpfile.ts [more_js_files].
images/web/assets/$(TALKYARD_VERSION)/more-bundle.js.gz: \
$(shell find client/app-more/ -type f \( -name '*.ts' -o -name '*.js' \)) \
client/types-and-const-enums.ts \
node_modules/react-bootstrap/dist/react-bootstrap.js \
node_modules/classnames/index.js \
node_modules/react-input-autosize/dist/react-input-autosize.js \
node_modules/react-select/dist/react-select.js \
node_modules/moment/min/moment.min.js
@echo "\nRegenerating: $@ ..."
$(d_c_nodejs_gulp) compileMoreTypescript-concatScripts
# Sync with gulpfile.ts [slim_js_files].
images/web/assets/$(TALKYARD_VERSION)/slim-bundle.js.gz: \
$(shell find client/app-slim/ -type f \( -name '*.ts' -o -name '*.js' \)) \
client/types-and-const-enums.ts \
node_modules/react/umd/react.development.js \
node_modules/react-dom/umd/react-dom.development.js \
node_modules/prop-types/prop-types.js \
node_modules/create-react-class/create-react-class.js \
node_modules/react-router-dom/umd/react-router-dom.js \
node_modules/react-dom-factories/index.js \
client/third-party/smoothscroll-tiny.js \
client/third-party/bliss.shy.js \
node_modules/keymaster/keymaster.js \
client/third-party/rename-key-to-keymaster.js \
client/third-party/lodash-custom.js \
node_modules/eventemitter3/umd/eventemitter3.min.js \
client/third-party/tiny-querystring.umd.js \
client/third-party/gifffer/gifffer.js \
client/third-party/get-set-cookie.js \
client/third-party/popuplib.js
@echo "\nRegenerating: $@ ..."
$(d_c_nodejs_gulp) compileSlimTypescript-concatScripts
images/web/assets/$(TALKYARD_VERSION)/staff-bundle.js.gz: \
$(shell find client/app-staff/ -type f \( -name '*.ts' -o -name '*.js' \)) \
client/types-and-const-enums.ts
@echo "\nRegenerating: $@ ..."
$(d_c_nodejs_gulp) compileStaffTypescript-concatScripts
images/web/assets/$(TALKYARD_VERSION)/zxcvbn.js.gz: \
node_modules/zxcvbn/dist/zxcvbn.js
@echo "\nRegenerating: $@ ..."
$(d_c_nodejs_gulp) bundleZxcvbn
images/web/assets/$(TALKYARD_VERSION)/styles-bundle.css.gz: \
$(shell find client/ -type f \( -name '*.styl' -o -name '*.css' \) )
@echo "\nRegenerating: $@ ..."
$(d_c_nodejs_gulp) compile-stylus
# ----- ext-iframe.js
# Skip minify, for now.
ext_iframe_js: \
images/web/assets/ext-iframe.min.js \
images/web/assets/ext-iframe.min.js.gz \
images/web/assets/ext-iframe.js.gz
images/web/assets/ext-iframe.min.js: client/ext-iframe.js
@cp client/ext-iframe.js images/web/assets/ext-iframe.min.js
images/web/assets/ext-iframe.min.js.gz: client/ext-iframe.js
@gzip -c client/ext-iframe.js > images/web/assets/ext-iframe.min.js.gz
images/web/assets/ext-iframe.js.gz: client/ext-iframe.js
@gzip -c client/ext-iframe.js > images/web/assets/ext-iframe.js.gz
# ----- Translations
# For Play Framework, the app container.
# E.g.: images/app/assets/translations/en_US/i18n.js etc.
transl_dev_app_bundle_files := \
${shell find translations/ -name '*.ts' \
| sed -nr 's;(.*)\.ts;images/app/assets/\1.js;p' }
# For Nginx, the web container — includes the version number, for asset versioning.
# E.g. images/web/assets/v0.2020.25/translations/en_US/i18n.js
transl_dev_web_bundle_files := \
${shell find translations/ -name '*.ts' \
| sed -nr 's;(.*)\.ts;images/web/assets/$(TALKYARD_VERSION)/\1.js;p' }
$(transl_dev_app_bundle_files) $(transl_dev_web_bundle_files): \
${shell find translations/ -name '*.ts' }
@echo "Generating translation files: Transpiling .ts to .js"
$(d_c_nodejs_gulp) buildTranslations
transl_dev_bundles: ${transl_dev_web_bundle_files} ${transl_dev_app_bundle_files}
# ----- Fonts
# Sync 'open-sans-v1' with gulpfile.js and images/web/Dockerfile. [sync_fonts]
fonts: images/web/fonts/open-sans-v2/open-sans.min.css.gz
images/web/fonts/open-sans-v2/open-sans.min.css.gz:
@echo "\nRegenerating: $@ ..."
$(d_c_nodejs_gulp) bundleFonts
debug_asset_bundles: \
git-subm-init-upd \
node_modules \
to-talkyard \
debug_asset_bundles_files \
fonts \
ext_iframe_js \
transl_dev_bundles
# ----- To-Talkyard Javascript
to-talkyard: to-talkyard/dist/to-talkyard/src/to-talkyard.js
to-talkyard/dist/to-talkyard/src/to-talkyard.js: $(shell find to-talkyard/src/)
@echo "Building To-Talkyard ..."
@cd to-talkyard ;\
set -x ;\
yarn ;\
yarn build
@echo "... Done building To-Talkyard."
# ----- Clean (wip)
clean_bundles:
@echo Delting script and style bundles:
$(d_c_nodejs_gulp) clean
clean: clean_bundles
@# target/ sometimes includes files compilation-created and owned by root.
@echo Delting Scala things and other things:
@$(call ask_for_root_password)
sudo rm -fr target/
rm -fr project/target/
rm -fr project/project/
rm -fr logs/
rm -f ensime-langserver.log
rm -f chromedriver.log
pristine: clean
@echo
@echo "If you want to, also delete Docker volumes, your local config,"
@echo "the SBT and Node.js cache, and IDE project files,"
@echo "by copy-pasting (some of) this:"
@echo
@echo " sudo rm -rf volumes/"
@echo
@echo " rm -fr conf/my.conf"
@echo
@echo " rm -fr .idea"
@echo " rm -fr .ensime"
@echo " rm -fr .ensime_cache/"
@echo
@echo " rm -fr modules/*/node_modules/"
@echo " rm -fr to-talkyard/node_modules/"
@echo " rm -fr tests/e2e/node_modules/"
@echo " rm -fr tests/e2e-wdio7/node_modules/"
@echo
@echo
# ----- Development
build:
@echo "Build what, dev or prod images? Do one of these:"
@echo " make dev-images"
@echo " make prod-images"
dev-images: debug_asset_bundles
$(d_c) build
# Starts an SBT shell where you can run unit tests by typing 'test'.
play-cli: debug_asset_bundles dead-app
s/d-cli
# Starts but uses prod assets bundles.
play-cli-prod: prod_asset_bundles dead-app
IS_PROD_TEST=true s/d-cli
db-cli:
@# Find out which database is currently being used, by looking at my.conf.
@# Because I sometimes connect as the wrong user, and feel confused for quite a while.
@def_user=`sed -nr 's/^talkyard.postgresql.user="([a-zA-Z0-9\._-]+)".*/\1/p' conf/my.conf` ;\
def_user="$${def_user:-talkyard}" ;\
read -p "Connect to the PostgreSQL database as which user? [$$def_user] " db_user ;\
db_user="$${db_user:-$$def_user}" ;\
s/d-psql "$$db_user" "$$db_user"
up: debug_asset_bundles
$(d_c) up -d
@echo
@echo "Started. Now, tailing logs..."
@echo
@$(d_c_logs_f0)
log: tail
logs: tail
tails: tail
tail:
$(d_c_logs_f0)
restart: debug_asset_bundles
@# Move to s/tyd? See comment in s/d-restart. Move all restart-* ?
s/d-restart
restart-web:
$(d_c) kill web ; $(d_c) start web ; $(d_c_logs_f0)
recreate-web:
$(d_c) kill web ; $(d_c) rm -f web ; $(d_c) up -d web ; $(d_c_logs_f0)
rebuild-restart-web:
$(d_c) kill web ; $(d_c) rm -f web ; $(d_c) build web ; $(d_c) up -d web ; $(d_c_logs_f0)
rebuild-nodejs:
$(d_c) kill nodejs ; $(d_c) rm -f nodejs ; $(d_c) build nodejs
#rebuild-restart-nodejs: rebuild-nodejs
# $(d_c) up -d nodejs ; $(d_c_logs_f0) nodejs
#
#restart-nodejs:
# $(d_c) kill nodejs ; $(d_c) start nodejs ; $(d_c_logs_f0)
restart-app: debug_asset_bundles
$(d_c) kill app ; $(d_c) start app ; $(d_c_logs_f0)
recreate-app: debug_asset_bundles
$(d_c) kill app ; $(d_c) rm -f app ; $(d_c) up -d app ; $(d_c_logs_f0)
rebuild-app: debug_asset_bundles
$(d_c) kill app ; $(d_c) rm -f app ; $(d_c) build app
rebuild-restart-app: rebuild-app
$(d_c) up -d app ; $(d_c_logs_f0)
dead-app:
$(d_c) kill web app
restart-web-app: debug_asset_bundles
@# Move to s/tyd? See comment in s/d-restart.
$(d_c) kill web app gulp ; $(d_c) start web app gulp ; $(d_c_logs) | s/impl/unjson.sh
down: dead
$(d_c) down
dead:
@# Kill the ones who are slow to stop.
$(d_c) kill app search ; $(d_c) stop
# Prod images
# ========================================
# Any old lingering prod build project, causes netw pool ip addr overlap error.
_kill_old_prod_build_project:
$(d_c) -pedt kill web app search cache rdb ;\
$(d_c) -pedt down
prod-images: _kill_old_prod_build_project
@# This cleans and builds prod_asset_bundles. [PRODBNDLS]
s/build-prod-images.sh
prod-images-only-e2e-tests: _kill_old_prod_build_project
@# This runs the e2e tests only.
s/build-prod-images.sh --skip-build
prod-images-only-e2e-tests-skip-restart:
@# This runs the e2e tests only, in supposedly already running Docker containers.
@# Useful if an e2e test failed because of harmless boring reasons.
s/build-prod-images.sh --skip-build --skip-restart
prod-images-skip-build-and-e2e-test: _kill_old_prod_build_project
s/build-prod-images.sh --skip-build --skip-e2e-tests
tag-and-push-latest-images: \
tag-latest-images push-tagged-images _print_push_git_tag_command
tag-latest-images:
@$(call die_unless_tag_specified, Tag with)
@$(call ask_for_root_password)
set -e ;\
REPO=$(DOCKER_REPOSITORY) ;\
sudo docker tag $$REPO/talkyard-app $$REPO/talkyard-app:$(tag) ;\
sudo docker tag $$REPO/talkyard-web $$REPO/talkyard-web:$(tag) ;\
sudo docker tag $$REPO/talkyard-rdb $$REPO/talkyard-rdb:$(tag) ;\
sudo docker tag $$REPO/talkyard-cache $$REPO/talkyard-cache:$(tag) ;\
sudo docker tag $$REPO/talkyard-search $$REPO/talkyard-search:$(tag) ;\
sudo docker tag $$REPO/talkyard-certgen $$REPO/talkyard-certgen:$(tag)
@echo
push-tagged-images:
@$(call die_unless_tag_specified, Push)
@$(call ask_for_root_password)
set -e ;\
REPO=$(DOCKER_REPOSITORY) ;\
sudo docker push $$REPO/talkyard-app:$(tag) ;\
sudo docker push $$REPO/talkyard-web:$(tag) ;\
sudo docker push $$REPO/talkyard-rdb:$(tag) ;\
sudo docker push $$REPO/talkyard-cache:$(tag) ;\
sudo docker push $$REPO/talkyard-search:$(tag) ;\
sudo docker push $$REPO/talkyard-certgen:$(tag)
@echo
_print_push_git_tag_command:
@echo "Next:"
@echo ""
@echo " make push_tag_to_dev_rel_branch tag=$(version_tag)"
@echo " make push_tag_to_dev_repo repo=origin tag=$(version_tag)"
@echo ""
# [bash2deno]
push_tag_to_dev_rel_branch:
@echo
@echo "Publishing version tag: $(tag)"
@echo " to release branch: $(DEV_RELEASE_CHANNEL) ..."
@echo
@$(call die_unless_tag_specified, Push)
@# Do Not push to master — doing that would include this version in tyse-v0-regular.
@# Exit on any error, so won't push something broken to the versions repo.
@#
@set -e ;\
cd relchans/$(DEV_RELEASE_CHANNEL)/ ;\
git fetch origin $(DEV_RELEASE_CHANNEL) ;\
git checkout -B $(DEV_RELEASE_CHANNEL) --track origin/$(DEV_RELEASE_CHANNEL) ;\
git merge --ff-only origin/$(DEV_RELEASE_CHANNEL) ;\
echo $(tag) >> version-tags.log ;\
git add version-tags.log ;\
git commit -m "Release $(tag), channel $(DEV_RELEASE_CHANNEL)." ;\
git push origin $(DEV_RELEASE_CHANNEL)
@# Later, this message instead:
@# git commit -m "Release tyse-$(tag)-$(DEV_RELEASE_CHANNEL_SUFFIX)."
@echo "Look, the dev release branch, now afterwards:"
@cd relchans/$(DEV_RELEASE_CHANNEL)/ ;\
set -x ;\
pwd ;\
git log --oneline -n5 ;\
tail -n5 version-tags.log
push_tag_to_dev_repo:
@# Note that this version might not be included in all release channels.
@# Example: If this new version includes some not-well-tested things — then,
@# we'd want to push it only to tyse-v0-dev, fix bugs, and later, push a more
@# well tested version first to tyse-v0-dev and then to tyse-v0-regular.
@#
@# It's nice to see directly in the main repo, in which release branches a
@# Ty version (Git revision) has been included? So let's incl the branch
@# name in the version tag. Then, a version (Git revision) that got incl in
@# many branches, gets one tag per branch, e.g. both
@# tyse-v0.2021.04-abc123def-dev and tyse-v0.2021.04-abc123def-regular, i.e.
@# same version nr and Git revision hash, but different -dev/-regular suffix.
@#
@echo ""
@echo "Pushing tag: tyse-$(tag)-$(DEV_RELEASE_CHANNEL_SUFFIX)"
@echo " to repo: $(repo) ..."
@git tag tyse-$(tag)-$(DEV_RELEASE_CHANNEL_SUFFIX) ;\
git push $(repo) tyse-$(tag)-$(DEV_RELEASE_CHANNEL_SUFFIX)
@echo ""
@echo "Done. Now, push 'release' and bump the version number:"
@echo ""
@echo " git push $(repo) release"
@echo " git checkout -B main"
@echo " s/bump-versions.sh"
@echo " git add version.txt relchans/tyse-v0-dev"
@echo ' git commit -m "Bump version to `cat version.txt`."'
@echo ""
define die_unless_tag_specified
if [ -z "$(tag)" ]; then \
echo ;\
echo "Error: $(1) which Docker image tag? Specify tag=... please." ;\
echo ;\
exit 1 ;\
fi
endef
# ----- Maybe read (again)?
#https://gist.github.com/mpneuried/0594963ad38e68917ef189b4e6a269db
# DOCKER_REPO=...
# http://datakurre.pandala.org/2016/04/evolution-of-our-makefile-for-docker.html
# capture test exit status code: ... see blog post
# https://serversforhackers.com/c/dckr-dev-workflow — log messages
# maybe read:
# http://aegis.sourceforge.net/auug97.pdf
# has read:
# https://serversforhackers.com/c/dckr-dev-workflow
# probably well constructed:
# https://github.com/PistonDevelopers/rust-empty/blob/master/Makefile
# https://github.com/git/git/blob/master/Makefile
# Bazel? No? Then everyone incl I need to spend time learning how it works:
# https://github.com/bazelbuild/rules_k8s and need to install Java.
# looks nice:
# https://github.com/casey/just
# vim: list ts=4 sw=4 tw=0 fo=r