Add documentation to the make file
Thanks to this excellent article[1] I can now type in ‘make’ to be reminded of what commands I have available. [1]: https://victoria.dev/blog/how-to-create-a-self-documenting-makefile/
This commit is contained in:
parent
8e2161b71f
commit
f31095e65d
1 changed files with 7 additions and 4 deletions
11
GNUmakefile
11
GNUmakefile
|
@ -1,8 +1,11 @@
|
||||||
.PHONY: publish deploy html css
|
.PHONY: publish deploy html css help
|
||||||
|
|
||||||
publish: html css
|
help: ## Show this help
|
||||||
|
@egrep -h '\s##\s' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-20s\033[0m %s\n", $$1, $$2}'
|
||||||
|
|
||||||
deploy:
|
publish: html css ## Build the site and copy it to the staging directory
|
||||||
|
|
||||||
|
deploy: ## Deploy the site to live
|
||||||
@[[ -e public/index.html ]] || (echo "Run make publish before deploy" && exit 1)
|
@[[ -e public/index.html ]] || (echo "Run make publish before deploy" && exit 1)
|
||||||
rsync --rsh="ssh -p 4511" --verbose --checksum --recursive --delete \
|
rsync --rsh="ssh -p 4511" --verbose --checksum --recursive --delete \
|
||||||
--exclude '*~' --exclude '.eldev' --delete-excluded \
|
--exclude '*~' --exclude '.eldev' --delete-excluded \
|
||||||
|
@ -22,7 +25,7 @@ public/assets/css/main.css public/assets/css/tekuti.css public/assets/css/cgit.c
|
||||||
public/assets/css/%.css: src/less/%.less
|
public/assets/css/%.css: src/less/%.less
|
||||||
lessc $< $@
|
lessc $< $@
|
||||||
|
|
||||||
clean:
|
clean: ## Remove all of the build files
|
||||||
@echo "Cleaning up..."
|
@echo "Cleaning up..."
|
||||||
@rm -rvf *.elc
|
@rm -rvf *.elc
|
||||||
@rm -rvf public
|
@rm -rvf public
|
||||||
|
|
Loading…
Reference in a new issue