hrfee/jfa-go
1
0
Fork 0
mirror of https://github.com/hrfee/jfa-go.git synced 2024-12-22 09:00:10 +00:00
Code Issues Projects Releases Wiki Activity
4c3e310634
jfa-go/Makefile

181 lines
4.6 KiB
Makefile
Raw Normal View History

add GOESBUILD option for platform without esbuild on npm
2021-02-11 18:21:21 +00:00
GOESBUILD ?= off
ifeq ($(GOESBUILD), on)
ESBUILD := esbuild
else
ESBUILD := npx esbuild
endif
Fix docker build, add GOBINARY flag for make GOBINARY defaults to "go", but if you want to build on a normal system, you'll likely set it to go1.16rc1 with "make all GOBINARY=go1.16rc1".
2021-02-01 20:55:17 +00:00
GOBINARY ?= go
add GOESBUILD option for platform without esbuild on npm
2021-02-11 18:21:21 +00:00
prefix css with version to avoid cache conflict
2022-01-08 16:42:36 +00:00
CSSVERSION ?= v3
fix tag versioning and dockerfile
2021-02-22 01:26:07 +00:00
VERSION ?= $(shell git describe --exact-match HEAD 2> /dev/null || echo vgit)
version with ldflags instead of script
2021-02-22 01:23:42 +00:00
VERSION := $(shell echo $(VERSION) | sed 's/v//g')
COMMIT ?= $(shell git rev-parse --short HEAD || echo unknown)
add basic update functionality If enabled, jfa-go pings buildrone (hosted at builds.hrfee.pw) every 30 min for new updates. If there is one, it gets information (and if applicable, a binary) from the appropriate source (buildrone, github, or dockerhub) and displays it on the admin page. You can switch update channels between stable and unstable. For binary releases, updates are downloaded automatically and installed when the user presses update. Since this obviously introduces some "phone-home" functionality into jfa-go, I just want to say IPs are not and will not be logged by buildrone, although I may later introduce functionality to give a rough idea of the number of users (again, no IPs stored). The whole thing can also be turned off in settings.
2021-03-07 15:23:44 +00:00
UPDATER ?= off
prefix css with version to avoid cache conflict
2022-01-08 16:42:36 +00:00
LDFLAGS := -X main.version=$(VERSION) -X main.commit=$(COMMIT) -X main.cssVersion=$(CSSVERSION)
add basic update functionality If enabled, jfa-go pings buildrone (hosted at builds.hrfee.pw) every 30 min for new updates. If there is one, it gets information (and if applicable, a binary) from the appropriate source (buildrone, github, or dockerhub) and displays it on the admin page. You can switch update channels between stable and unstable. For binary releases, updates are downloaded automatically and installed when the user presses update. Since this obviously introduces some "phone-home" functionality into jfa-go, I just want to say IPs are not and will not be logged by buildrone, although I may later introduce functionality to give a rough idea of the number of users (again, no IPs stored). The whole thing can also be turned off in settings.
2021-03-07 15:23:44 +00:00
ifeq ($(UPDATER), on)
use build constraints for embed, clean up makefile internal-files/external-files and compile-debug are gone, the environment variables INTERNAL=on/off and DEBUG=on/off replace them.
2021-04-01 13:22:11 +00:00
LDFLAGS := $(LDFLAGS) -X main.updater=binary
add basic update functionality If enabled, jfa-go pings buildrone (hosted at builds.hrfee.pw) every 30 min for new updates. If there is one, it gets information (and if applicable, a binary) from the appropriate source (buildrone, github, or dockerhub) and displays it on the admin page. You can switch update channels between stable and unstable. For binary releases, updates are downloaded automatically and installed when the user presses update. Since this obviously introduces some "phone-home" functionality into jfa-go, I just want to say IPs are not and will not be logged by buildrone, although I may later introduce functionality to give a rough idea of the number of users (again, no IPs stored). The whole thing can also be turned off in settings.
2021-03-07 15:23:44 +00:00
else ifneq ($(UPDATER), off)
use build constraints for embed, clean up makefile internal-files/external-files and compile-debug are gone, the environment variables INTERNAL=on/off and DEBUG=on/off replace them.
2021-04-01 13:22:11 +00:00
LDFLAGS := $(LDFLAGS) -X main.updater=$(UPDATER)
endif
matrix: E2EE as build option since this is so broken and requires CGO deps, E2EE support is now only included with "make E2EE=on ...". The option to enable will then appear in settings.
2021-07-16 14:41:08 +00:00
use build constraints for embed, clean up makefile internal-files/external-files and compile-debug are gone, the environment variables INTERNAL=on/off and DEBUG=on/off replace them.
2021-04-01 13:22:11 +00:00
INTERNAL ?= on
matrix: E2EE as build option since this is so broken and requires CGO deps, E2EE support is now only included with "make E2EE=on ...". The option to enable will then appear in settings.
2021-07-16 14:41:08 +00:00
TRAY ?= off
E2EE ?= off
TAGS := -tags "
use build constraints for embed, clean up makefile internal-files/external-files and compile-debug are gone, the environment variables INTERNAL=on/off and DEBUG=on/off replace them.
2021-04-01 13:22:11 +00:00
ifeq ($(INTERNAL), on)
DATA := data
else
DATA := build/data
matrix: E2EE as build option since this is so broken and requires CGO deps, E2EE support is now only included with "make E2EE=on ...". The option to enable will then appear in settings.
2021-07-16 14:41:08 +00:00
TAGS := $(TAGS) external
add basic update functionality If enabled, jfa-go pings buildrone (hosted at builds.hrfee.pw) every 30 min for new updates. If there is one, it gets information (and if applicable, a binary) from the appropriate source (buildrone, github, or dockerhub) and displays it on the admin page. You can switch update channels between stable and unstable. For binary releases, updates are downloaded automatically and installed when the user presses update. Since this obviously introduces some "phone-home" functionality into jfa-go, I just want to say IPs are not and will not be logged by buildrone, although I may later introduce functionality to give a rough idea of the number of users (again, no IPs stored). The whole thing can also be turned off in settings.
2021-03-07 15:23:44 +00:00
endif
matrix: E2EE as build option since this is so broken and requires CGO deps, E2EE support is now only included with "make E2EE=on ...". The option to enable will then appear in settings.
2021-07-16 14:41:08 +00:00
ifeq ($(TRAY), on)
add basic tray functionality enable with `make TRAY=on ...`. Cross compilation apparently should work from linux to linux & windows.
2021-05-16 15:23:28 +00:00
TAGS := $(TAGS) tray
endif
matrix: E2EE as build option since this is so broken and requires CGO deps, E2EE support is now only included with "make E2EE=on ...". The option to enable will then appear in settings.
2021-07-16 14:41:08 +00:00
ifeq ($(E2EE), on)
TAGS := $(TAGS) e2ee
endif
TAGS := $(TAGS)"
add basic tray functionality enable with `make TRAY=on ...`. Cross compilation apparently should work from linux to linux & windows.
2021-05-16 15:23:28 +00:00
OS := $(shell go env GOOS)
ifeq ($(TRAY)$(OS), onwindows)
LDFLAGS := $(LDFLAGS) -H=windowsgui
endif
remove ts-debug
2021-04-01 13:33:57 +00:00
DEBUG ?= off
ifeq ($(DEBUG), on)
SOURCEMAP := --sourcemap
add typechecking step to Makefile when DEBUG=on
2021-05-03 17:32:56 +00:00
TYPECHECK := tsc -noEmit --project ts/tsconfig.json
remove ts-debug
2021-04-01 13:33:57 +00:00
# jank
merge tailwind and upgraded a17t a17t v0.10 became a tailwind plugin rather than standalone css, and made some other changes. Much of the original custom CSS now uses tailwind classes, and there have been some other UI changes.
2022-01-04 20:12:19 +00:00
COPYTS := rm -r $(DATA)/web/js/ts; cp -r tempts $(DATA)/web/js/ts
move copy button to right, don't uncss when DEBUG=on keep unused css when DEBUG=on by skipping the uncss step.
2021-06-13 15:31:40 +00:00
UNCSS := cp $(DATA)/web/css/bundle.css $(DATA)/bundle.css
switch to DOM based variant adding
2021-12-30 23:52:53 +00:00
TAILWIND := --content ""
remove ts-debug
2021-04-01 13:33:57 +00:00
else
cleanup; fix stripping with DEBUG=on
2021-05-16 14:00:13 +00:00
LDFLAGS := -s -w $(LDFLAGS)
remove ts-debug
2021-04-01 13:33:57 +00:00
SOURCEMAP :=
COPYTS :=
add typechecking step to Makefile when DEBUG=on
2021-05-03 17:32:56 +00:00
TYPECHECK :=
fix crash page
2021-12-31 15:09:33 +00:00
UNCSS := npx tailwindcss -i $(DATA)/web/css/bundle.css -o $(DATA)/bundle.css --content "html/crash.html"
# UNCSS := npx uncss $(DATA)/crash.html --csspath web/css --output $(DATA)/bundle.css
switch to DOM based variant adding
2021-12-30 23:52:53 +00:00
TAILWIND :=
remove ts-debug
2021-04-01 13:33:57 +00:00
endif
Discord: Try to avoid more race conditions also added RACE=on to Makefile to enable go's race detector.
2021-05-23 21:26:56 +00:00
RACE ?= off
ifeq ($(RACE), on)
RACEDETECTOR := -race
else
RACEDETECTOR :=
endif
Merge a17t-redesign, kinda ts-ify setup.js the web ui has been redesigned with the a17t toolkit, which imo looks a lot better than bootstrap. This also brought a complete rework of the web code, which now makes a lot more sense hopefully. the setup page is still stuck with bootstrap, its not much of a priority but i'll rewrite it eventually.
2021-01-05 18:16:23 +00:00
npm:
$(info installing npm dependencies)
npm install
add GOESBUILD option for platform without esbuild on npm
2021-02-11 18:21:21 +00:00
@if [ "$(GOESBUILD)" = "off" ]; then\
npm install esbuild;\
else\
go get -u github.com/evanw/esbuild/cmd/esbuild;\
fi
Merge a17t-redesign, kinda ts-ify setup.js the web ui has been redesigned with the a17t toolkit, which imo looks a lot better than bootstrap. This also brought a complete rework of the web code, which now makes a lot more sense hopefully. the setup page is still stuck with bootstrap, its not much of a priority but i'll rewrite it eventually.
2021-01-05 18:16:23 +00:00
Added makefile Alternative to goreleaser.
2020-08-03 17:00:54 +00:00
configuration:
rewrite* most web ui code in typescript i wanted to split up the web ui components into multiple files, and figured it'd be a good chance to try out typescript. run make typescript to compile everything in ts/ and put it in data/static/. This is less of a rewrite and more of a refactoring, most of it still works the same but bits have been cleaned up too. Remaining javascript found in setup.js and form.html
2020-09-21 21:03:20 +00:00
$(info Fixing config-base)
use build constraints for embed, clean up makefile internal-files/external-files and compile-debug are gone, the environment variables INTERNAL=on/off and DEBUG=on/off replace them.
2021-04-01 13:22:11 +00:00
-mkdir -p $(DATA)
python3 scripts/enumerate_config.py -i config/config-base.json -o $(DATA)/config-base.json
rewrite* most web ui code in typescript i wanted to split up the web ui components into multiple files, and figured it'd be a good chance to try out typescript. run make typescript to compile everything in ts/ and put it in data/static/. This is less of a rewrite and more of a refactoring, most of it still works the same but bits have been cleaned up too. Remaining javascript found in setup.js and form.html
2020-09-21 21:03:20 +00:00
$(info Generating config-default.ini)
use build constraints for embed, clean up makefile internal-files/external-files and compile-debug are gone, the environment variables INTERNAL=on/off and DEBUG=on/off replace them.
2021-04-01 13:22:11 +00:00
python3 scripts/generate_ini.py -i config/config-base.json -o $(DATA)/config-default.ini
Added makefile Alternative to goreleaser.
2020-08-03 17:00:54 +00:00
use npx to avoid looking for node_modules, get rid of useless get_node_deps makefile works without interaction by default now.
2020-10-17 23:57:53 +00:00
email:
rewrite* most web ui code in typescript i wanted to split up the web ui components into multiple files, and figured it'd be a good chance to try out typescript. run make typescript to compile everything in ts/ and put it in data/static/. This is less of a rewrite and more of a refactoring, most of it still works the same but bits have been cleaned up too. Remaining javascript found in setup.js and form.html
2020-09-21 21:03:20 +00:00
$(info Generating email html)
use build constraints for embed, clean up makefile internal-files/external-files and compile-debug are gone, the environment variables INTERNAL=on/off and DEBUG=on/off replace them.
2021-04-01 13:22:11 +00:00
python3 scripts/compile_mjml.py -o $(DATA)/
Added makefile Alternative to goreleaser.
2020-08-03 17:00:54 +00:00
rename ts to typescript unusual name conflict meant this step gets skipped.
2021-01-05 18:40:19 +00:00
typescript:
add typechecking step to Makefile when DEBUG=on
2021-05-03 17:32:56 +00:00
$(TYPECHECK)
add dark variants to ts janky but works, and should report if theres a situation its not ready to handle.
2021-12-30 02:45:29 +00:00
$(adding dark variants to typescript)
makefile changes
2022-01-30 18:03:21 +00:00
rm -rf tempts
add dark variants to ts janky but works, and should report if theres a situation its not ready to handle.
2021-12-30 02:45:29 +00:00
cp -r ts tempts
merge tailwind and upgraded a17t a17t v0.10 became a tailwind plugin rather than standalone css, and made some other changes. Much of the original custom CSS now uses tailwind classes, and there have been some other UI changes.
2022-01-04 20:12:19 +00:00
scripts/dark-variant.sh tempts
scripts/dark-variant.sh tempts/modules
Merge a17t-redesign, kinda ts-ify setup.js the web ui has been redesigned with the a17t toolkit, which imo looks a lot better than bootstrap. This also brought a complete rework of the web code, which now makes a lot more sense hopefully. the setup page is still stuck with bootstrap, its not much of a priority but i'll rewrite it eventually.
2021-01-05 18:16:23 +00:00
$(info compiling typescript)
makefile changes
2022-01-30 18:03:21 +00:00
mkdir -p $(DATA)/web/js
dont ignore esbuild errors
2022-01-30 17:59:52 +00:00
$(ESBUILD) --bundle tempts/admin.ts $(SOURCEMAP) --outfile=./$(DATA)/web/js/admin.js --minify
$(ESBUILD) --bundle tempts/pwr.ts $(SOURCEMAP) --outfile=./$(DATA)/web/js/pwr.js --minify
$(ESBUILD) --bundle tempts/form.ts $(SOURCEMAP) --outfile=./$(DATA)/web/js/form.js --minify
$(ESBUILD) --bundle tempts/setup.ts $(SOURCEMAP) --outfile=./$(DATA)/web/js/setup.js --minify
$(ESBUILD) --bundle tempts/crash.ts --outfile=./$(DATA)/crash.js --minify
remove ts-debug
2021-04-01 13:33:57 +00:00
$(COPYTS)
add ts-debug option to makefile for including typescript and sourcemaps
2020-09-23 19:14:16 +00:00
Add basic swagger documentation accessible by running with -swagger. Accessible at /swagger/index.html. Currently doesn't have authentication setup, so no requests will work.
2020-09-24 16:51:13 +00:00
swagger:
use go install for swag in goreleaser
2022-03-22 15:15:57 +00:00
$(GOBINARY) install github.com/swaggo/swag/cmd/swag@latest
Add basic swagger documentation accessible by running with -swagger. Accessible at /swagger/index.html. Currently doesn't have authentication setup, so no requests will work.
2020-09-24 16:51:13 +00:00
swag init -g main.go
Added makefile Alternative to goreleaser.
2020-08-03 17:00:54 +00:00
compile:
strip debug symbols in makefile
2021-02-05 13:01:45 +00:00
$(info Downloading deps)
$(GOBINARY) mod download
$(info Building)
mkdir -p build
Discord: Try to avoid more race conditions also added RACE=on to Makefile to enable go's race detector.
2021-05-23 21:26:56 +00:00
$(GOBINARY) build $(RACEDETECTOR) -ldflags="$(LDFLAGS)" $(TAGS) -o build/jfa-go
Disable cgo and add compress step to makefile
2020-09-02 19:06:02 +00:00
compress:
upx --lzma build/jfa-go
Added makefile Alternative to goreleaser.
2020-08-03 17:00:54 +00:00
bundle css with esbuild
2021-01-23 18:53:14 +00:00
bundle-css:
makefile changes
2022-01-30 18:03:21 +00:00
mkdir -p $(DATA)/web/css
bundle css with esbuild
2021-01-23 18:53:14 +00:00
$(info bundling css)
use build constraints for embed, clean up makefile internal-files/external-files and compile-debug are gone, the environment variables INTERNAL=on/off and DEBUG=on/off replace them.
2021-04-01 13:22:11 +00:00
$(ESBUILD) --bundle css/base.css --outfile=$(DATA)/web/css/bundle.css --external:remixicon.css --minify
switch to DOM based variant adding
2021-12-30 23:52:53 +00:00
npx tailwindcss -i $(DATA)/web/css/bundle.css -o $(DATA)/web/css/bundle.css $(TAILWIND)
# npx postcss -o $(DATA)/web/css/bundle.css $(DATA)/web/css/bundle.css
Show log on log.Fatal calls, provide "sanitized" version, fix goreleaser Sanitization means change anything in double quotes to "CENSORED". A notice is included telling the user to check for themselves as well.
2021-06-11 22:14:16 +00:00
build: fix css bundling bug with new esbuild local testing was being done with an older version of esbuild which didn't mind @tailwind statements before @imports (it complained, but did its job). On the latest version used in Docker builds, it would leave the @import statements intact which broke things like modals.
2022-01-26 14:26:10 +00:00
inline-css:
Generate crash report txt and webpage The last 100 lines of logs are now cached, and when a crash occurs, they are saved to a file in the temp directory ("/tmp" on *nix), and pretty HTML version is also created and opened in the browser. * Currently only handles panics, will be included in more places soon * Copy button and button to generate a GH issue will be added
2021-06-11 20:56:53 +00:00
cp html/crash.html $(DATA)/crash.html
move copy button to right, don't uncss when DEBUG=on keep unused css when DEBUG=on by skipping the uncss step.
2021-06-13 15:31:40 +00:00
$(UNCSS)
remove vulnerable node deps, cleanup
2021-11-14 14:50:40 +00:00
node scripts/inline.js root $(DATA) $(DATA)/crash.html $(DATA)/crash.html
remove inline-css-cli build dep unnecessary (inline-source-cli already includes its functionality) and a dependency of it had a high-severity CVE (wouldn't have affected anyone, but w/e).
2021-06-11 22:39:38 +00:00
rm $(DATA)/bundle.css
bundle css with esbuild
2021-01-23 18:53:14 +00:00
tailwind: upgrade a17t, somewhat functional dark mode instead of adding dark: variants to each element, a preprocessor script adds them. still needs to be implemented to typescript.
2021-12-30 00:49:43 +00:00
variants-html:
$(info copying html)
cp -r html $(DATA)/
$(info adding dark variants to html)
switch to DOM based variant adding
2021-12-30 23:52:53 +00:00
node scripts/missing-colors.js html $(DATA)/html
tailwind: upgrade a17t, somewhat functional dark mode instead of adding dark: variants to each element, a preprocessor script adds them. still needs to be implemented to typescript.
2021-12-30 00:49:43 +00:00
bundle css with esbuild
2021-01-23 18:53:14 +00:00
copy:
$(info copying fonts)
use build constraints for embed, clean up makefile internal-files/external-files and compile-debug are gone, the environment variables INTERNAL=on/off and DEBUG=on/off replace them.
2021-04-01 13:22:11 +00:00
cp -r node_modules/remixicon/fonts/remixicon.css node_modules/remixicon/fonts/remixicon.woff2 $(DATA)/web/css/
tailwind: upgrade a17t, somewhat functional dark mode instead of adding dark: variants to each element, a preprocessor script adds them. still needs to be implemented to typescript.
2021-12-30 00:49:43 +00:00
$(info copying crash page)
Generate crash report txt and webpage The last 100 lines of logs are now cached, and when a crash occurs, they are saved to a file in the temp directory ("/tmp" on *nix), and pretty HTML version is also created and opened in the browser. * Currently only handles panics, will be included in more places soon * Copy button and button to generate a GH issue will be added
2021-06-11 20:56:53 +00:00
mv $(DATA)/crash.html $(DATA)/html/
Merge a17t-redesign, kinda ts-ify setup.js the web ui has been redesigned with the a17t toolkit, which imo looks a lot better than bootstrap. This also brought a complete rework of the web code, which now makes a lot more sense hopefully. the setup page is still stuck with bootstrap, its not much of a priority but i'll rewrite it eventually.
2021-01-05 18:16:23 +00:00
$(info copying static data)
makefile changes
2022-01-30 18:03:21 +00:00
mkdir -p $(DATA)/web
use build constraints for embed, clean up makefile internal-files/external-files and compile-debug are gone, the environment variables INTERNAL=on/off and DEBUG=on/off replace them.
2021-04-01 13:22:11 +00:00
cp -r static/* $(DATA)/web/
add "systemd" command to generate a .service file never got around to adding this from jellyfin-accounts for some reason.
2021-04-24 17:54:31 +00:00
$(info copying systemd service)
cp jfa-go.service $(DATA)/
Merge a17t-redesign, kinda ts-ify setup.js the web ui has been redesigned with the a17t toolkit, which imo looks a lot better than bootstrap. This also brought a complete rework of the web code, which now makes a lot more sense hopefully. the setup page is still stuck with bootstrap, its not much of a priority but i'll rewrite it eventually.
2021-01-05 18:16:23 +00:00
$(info copying language files)
use build constraints for embed, clean up makefile internal-files/external-files and compile-debug are gone, the environment variables INTERNAL=on/off and DEBUG=on/off replace them.
2021-04-01 13:22:11 +00:00
cp -r lang $(DATA)/
cp LICENSE $(DATA)/
prefix css with version to avoid cache conflict
2022-01-08 16:42:36 +00:00
mv $(DATA)/web/css/bundle.css $(DATA)/web/css/$(CSSVERSION)bundle.css
use build constraints for embed, clean up makefile internal-files/external-files and compile-debug are gone, the environment variables INTERNAL=on/off and DEBUG=on/off replace them.
2021-04-01 13:22:11 +00:00
# internal-files:
# python3 scripts/embed.py internal
#
# external-files:
# python3 scripts/embed.py external
# -mkdir -p build
# $(info copying internal data into build/)
# cp -r data build/
Added makefile Alternative to goreleaser.
2020-08-03 17:00:54 +00:00
Added install step to makefile; start PKGBUILD Also added MIT License
2020-08-19 11:10:34 +00:00
install:
cp -r build $(DESTDIR)/jfa-go
use build constraints for embed, clean up makefile internal-files/external-files and compile-debug are gone, the environment variables INTERNAL=on/off and DEBUG=on/off replace them.
2021-04-01 13:22:11 +00:00
clean:
-rm -r $(DATA)
-rm -r build
-rm mail/*.html
-rm docs/docs.go docs/swagger.json docs/swagger.yaml
go clean
build: fix css bundling bug with new esbuild local testing was being done with an older version of esbuild which didn't mind @tailwind statements before @imports (it complained, but did its job). On the latest version used in Docker builds, it would leave the @import statements intact which broke things like modals.
2022-01-26 14:26:10 +00:00
all: configuration npm email typescript variants-html bundle-css inline-css swagger copy compile
Reference in New Issue Copy Permalink