Greatly improve 'make help'
This commit is contained in:
Radon Rosborough
parent
25c5dc8980
commit
6e3250e943
|
|
@ -2,6 +2,7 @@
|
|||
**/*.log
|
||||
**/*.pem
|
||||
**/.env
|
||||
**/.lsp-repl-history
|
||||
**/.terraform
|
||||
**/build
|
||||
**/node_modules
|
||||
|
|
|
|||
91
Makefile
91
Makefile
|
|
@ -23,13 +23,16 @@ MAKE_QUIETLY := MAKELEVEL= make
|
|||
|
||||
.PHONY: all $(MAKECMDGOALS)
|
||||
|
||||
help:
|
||||
help: # Show available Makefile targets
|
||||
@echo "usage:"
|
||||
@echo
|
||||
@cat Makefile | \
|
||||
grep -E '^[^.:[:space:]]+:|[#]#' | \
|
||||
sed -E 's/([^.:[:space:]]+):.*/ make \1/' | \
|
||||
sed -E 's/[#][#]# *(.+)/\n (\1)\n/'
|
||||
grep -E '^[^.:[:space:]]+:|[#]##' | \
|
||||
sed -E 's/:[^#]*#([^:]+)$$/: #:\1/' | \
|
||||
sed -E 's/([^.:[:space:]]+):([^#]*#(.+))?.*/ make \1\3/' | \
|
||||
sed -E 's/[#][#]# *(.+)/\n (\1)\n/' | \
|
||||
sed 's/$$/:/' | \
|
||||
column -ts:
|
||||
|
||||
### Build packaging scripts
|
||||
|
||||
|
|
@ -39,7 +42,7 @@ else
|
|||
NO_CACHE :=
|
||||
endif
|
||||
|
||||
image:
|
||||
image: # I=<image> [NC=1] : Build a Docker image
|
||||
@: $${I}
|
||||
ifeq ($(I),composite)
|
||||
node tools/build-composite-image.js
|
||||
|
|
@ -49,54 +52,54 @@ else
|
|||
hash="$$(node tools/hash-dockerfile.js $(I) | grep .)"; docker build . -f docker/$(I)/Dockerfile -t riju:$(I) --label riju.image-hash="$${hash}" $(NO_CACHE)
|
||||
endif
|
||||
|
||||
script:
|
||||
script: # L=<lang> T=<type> : Generate a packaging script
|
||||
@: $${L} $${T}
|
||||
mkdir -p $(BUILD)
|
||||
node tools/generate-build-script.js --lang $(L) --type $(T) > $(BUILD)/build.bash
|
||||
chmod +x $(BUILD)/build.bash
|
||||
|
||||
scripts:
|
||||
scripts: # L=<lang> : Generate both lang and config packaging scripts
|
||||
@: $${L}
|
||||
node tools/make-foreach.js --types script L=$(L)
|
||||
|
||||
all-scripts:
|
||||
all-scripts: # Generate all packaging scripts
|
||||
node tools/write-all-build-scripts.js
|
||||
|
||||
### Run packaging scripts
|
||||
|
||||
pkg-clean:
|
||||
pkg-clean: # L=<lang> T=<type> : Set up fresh packaging environment
|
||||
@: $${L} $${T}
|
||||
rm -rf $(BUILD)/src $(BUILD)/pkg
|
||||
mkdir -p $(BUILD)/src $(BUILD)/pkg
|
||||
|
||||
pkg-build:
|
||||
pkg-build: # L=<lang> T=<type> : Run packaging script in packaging environment
|
||||
@: $${L} $${T}
|
||||
cd $(BUILD)/src && pkg="$(PWD)/$(BUILD)/pkg" src="$(PWD)/$(BUILD)/src" $(or $(BASH_CMD),../build.bash)
|
||||
|
||||
pkg-debug:
|
||||
pkg-debug: # L=<lang> T=<type> : Launch shell in packaging environment
|
||||
@: $${L} $${T}
|
||||
$(MAKE_QUIETLY) pkg-build L=$(L) T=$(T) CMD=bash
|
||||
|
||||
Z ?= none
|
||||
|
||||
pkg-deb:
|
||||
pkg-deb: # L=<lang> T=<type> [Z=gzip|xz] : Build .deb from packaging environment
|
||||
@: $${L} $${T}
|
||||
fakeroot dpkg-deb --build -Z$(Z) $(BUILD)/pkg $(BUILD)/$(DEB)
|
||||
|
||||
pkg: pkg-clean pkg-build pkg-deb
|
||||
pkg: pkg-clean pkg-build pkg-deb # L=<lang> T=<type> [Z=gzip|xz] : Build fresh .deb
|
||||
|
||||
pkgs:
|
||||
pkgs: # L=<lang> [Z=gzip|xz] : Build both lang and config .debs
|
||||
@: $${L}
|
||||
node tools/make-foreach.js --types pkg L=$(L)
|
||||
|
||||
### Install packages
|
||||
|
||||
install:
|
||||
install: # L=<lang> T=<type> : Install built .deb
|
||||
@: $${L} $${T}
|
||||
if [[ -z "$$(ls -A /var/lib/apt/lists)" ]]; then sudo apt update; fi
|
||||
DEBIAN_FRONTEND=noninteractive sudo -E apt reinstall -y ./$(BUILD)/$(DEB)
|
||||
|
||||
installs:
|
||||
installs: # L=<lang> : Install both lang and config .debs
|
||||
@: $${L}
|
||||
node tools/make-foreach.js --types install L=$(L)
|
||||
|
||||
|
|
@ -115,7 +118,7 @@ endif
|
|||
|
||||
SHELL_ENV := -e Z -e CI -e TEST_PATIENCE -e TEST_CONCURRENCY
|
||||
|
||||
shell:
|
||||
shell: # I=<shell> [E=1] [P1|P2=<port>] : Launch Docker image with shell
|
||||
@: $${I}
|
||||
ifneq (,$(filter $(I),admin ci))
|
||||
docker run -it --rm --hostname $(I) -v $(VOLUME_MOUNT):/src -v /var/run/docker.sock:/var/run/docker.sock -v $(HOME)/.aws:/var/riju/.aws -v $(HOME)/.docker:/var/riju/.docker -v $(HOME)/.ssh:/var/riju/.ssh -v $(HOME)/.terraform.d:/var/riju/.terraform.d -e AWS_REGION -e AWS_ACCESS_KEY_ID -e AWS_SECRET_ACCESS_KEY -e DOCKER_USERNAME -e DOCKER_PASSWORD -e DEPLOY_SSH_PRIVATE_KEY -e DOCKER_REPO -e S3_BUCKET -e DOMAIN -e VOLUME_MOUNT=$(VOLUME_MOUNT) $(SHELL_PORTS) $(SHELL_ENV) --network host riju:$(I) $(BASH_CMD)
|
||||
|
|
@ -127,98 +130,98 @@ else
|
|||
docker run -it --rm --hostname $(I) -v $(VOLUME_MOUNT):/src $(SHELL_PORTS) $(SHELL_ENV) riju:$(I) $(BASH_CMD)
|
||||
endif
|
||||
|
||||
repkg: script
|
||||
repkg: script # L=<lang> T=<type> : Build fresh .deb and install into live container
|
||||
@: $${L} $${T}
|
||||
$(MAKE_QUIETLY) shell I=packaging CMD="make pkg L=$(L) T=$(T)"
|
||||
ctr="$$(docker container ls -f label="riju-install-target=yes" -l -q)"; test "$${ctr}" || (echo "no valid container is live"; exit 1); docker exec "$${ctr}" make install L=$(L) T=$(T)
|
||||
|
||||
repkgs:
|
||||
repkgs: # L=<lang> : Build and install fresh lang and config .debs
|
||||
@: $${L}
|
||||
node tools/make-foreach.js --types repkg L=$(L)
|
||||
|
||||
### Build and run application code
|
||||
|
||||
frontend:
|
||||
frontend: # Compile frontend assets for production
|
||||
npx webpack --mode=production
|
||||
|
||||
frontend-dev:
|
||||
frontend-dev: # Compile and watch frontend assets for development
|
||||
watchexec -w webpack.config.cjs -w node_modules -r --no-environment -- "echo 'Running webpack...' >&2; npx webpack --mode=development --watch"
|
||||
|
||||
system:
|
||||
system: # Compile setuid binary for production
|
||||
./system/compile.bash
|
||||
|
||||
system-dev:
|
||||
system-dev: # Compile and watch setuid binary for development
|
||||
watchexec -w system/src -n -- ./system/compile.bash
|
||||
|
||||
server:
|
||||
server: # Run server for production
|
||||
node backend/server.js
|
||||
|
||||
server-dev:
|
||||
server-dev: # Run and restart server for development
|
||||
watchexec -w backend -r -n -- node backend/server.js
|
||||
|
||||
build: frontend system
|
||||
build: frontend system # Compile all artifacts for production
|
||||
|
||||
dev:
|
||||
dev: # Compile, run, and watch all artifacts and server for development
|
||||
$(MAKE_QUIETLY) -j3 frontend-dev system-dev server-dev
|
||||
|
||||
### Application tools
|
||||
|
||||
test:
|
||||
node backend/test-runner.js $(F)
|
||||
test: # L=<filter> : Run test(s) for language or test category
|
||||
node backend/test-runner.js $(L)
|
||||
|
||||
sandbox:
|
||||
sandbox: # L=<lang> : Run isolated shell with per-language setup
|
||||
@: $${L}
|
||||
L=$(L) node backend/sandbox.js
|
||||
|
||||
lsp:
|
||||
lsp: # L=<lang|cmd> : Run LSP REPL for language or custom command line
|
||||
@: $${C}
|
||||
node backend/lsp-repl.js $(C)
|
||||
node backend/lsp-repl.js $(L)
|
||||
|
||||
### Fetch artifacts from registries
|
||||
|
||||
pull-base:
|
||||
pull-base: # Pull latest base image(s) from Docker Hub
|
||||
docker pull ubuntu:rolling
|
||||
|
||||
pull:
|
||||
pull: # I=<image> : Pull last published Riju image from Docker Hub
|
||||
@: $${I} $${DOCKER_REPO}
|
||||
docker pull $(DOCKER_REPO):$(I)
|
||||
docker tag $(DOCKER_REPO):$(I) riju:$(I)
|
||||
|
||||
download:
|
||||
download: # L=<lang> T=<type> : Download last published .deb from S3
|
||||
@: $${L} $${T} $${S3_BUCKET}
|
||||
mkdir -p $(BUILD)
|
||||
aws s3 cp $(S3_DEB) $(BUILD)/$(DEB)
|
||||
|
||||
plan:
|
||||
plan: # Display plan to pull/rebuild outdated or missing artifacts
|
||||
node tools/plan-publish.js
|
||||
|
||||
sync:
|
||||
sync: # Pull/rebuild outdated or missing artifacts
|
||||
node tools/plan-publish.js --execute
|
||||
|
||||
### Publish artifacts to registries
|
||||
|
||||
push:
|
||||
push: # I=<image> : Push Riju image to Docker Hub
|
||||
@: $${I} $${DOCKER_REPO}
|
||||
docker tag riju:$(I) $(DOCKER_REPO):$(I)
|
||||
docker push $(DOCKER_REPO):$(I)
|
||||
|
||||
upload:
|
||||
upload: # L=<lang> T=<type> : Upload .deb to S3
|
||||
@: $${L} $${T} $${S3_BUCKET}
|
||||
aws s3 rm --recursive $(S3_HASH)
|
||||
aws s3 cp $(BUILD)/$(DEB) $(S3_DEB)
|
||||
hash="$$(dpkg-deb -f $(BUILD)/$(DEB) Riju-Script-Hash | grep .)"; aws s3 cp - "$(S3_HASH)/$${hash}" < /dev/null
|
||||
|
||||
publish:
|
||||
publish: # Full synchronization and prod deployment
|
||||
tools/publish.bash
|
||||
|
||||
### Miscellaneous
|
||||
|
||||
dockerignore:
|
||||
dockerignore: # Update .dockerignore from .gitignore
|
||||
echo "# This file is generated by 'make dockerignore', do not edit." > .dockerignore
|
||||
cat .gitignore | sed 's#^#**/#' >> .dockerignore
|
||||
|
||||
env:
|
||||
env: # Run shell with .env file loaded and $PATH fixed
|
||||
exec bash --rcfile <(cat ~/.bashrc - <<< 'PS1="[.env] $$PS1"')
|
||||
|
||||
tmux:
|
||||
tmux attach || tmux new-session -s tmux
|
||||
tmux: # Start or attach to tmux session
|
||||
MAKELEVEL= tmux attach || MAKELEVEL= tmux new-session -s tmux
|
||||
|
|
|
|||
Loading…
Reference in New Issue