hishtory/Makefile

MAKEFLAGS += --always-make

help:				## Show this help.
	@fgrep -h "##" $(MAKEFILE_LIST) | fgrep -v fgrep | sed -e 's/\\$$//' | sed -e 's/##//'

fmt:				## Format all files
	gofumpt -l -w -extra .
	gci write --custom-order -s standard -s 'Prefix(github.com/ddworken/hishtory)' -s default .

local-install:			## Build and install hishtory locally from the current directory
	go build; ./hishtory install

forcetest:			## Force running all tests without a test cache
	go clean -testcache
	make test

test:				## Run all tests
	TZ='America/Los_Angeles' HISHTORY_TEST=1 HISHTORY_SKIP_INIT_IMPORT=1 gotestsum --packages ./... --rerun-fails=5 --rerun-fails-max-failures=15 --format testname --jsonfile /tmp/testrun.json --post-run-command "go run client/posttest/main.go export" -- -p 1 -timeout 90m

ftest:				## Run a specific test specified via `make ftest FILTER=TestParam/testTui/color` or `make ftest FILTER=TestImportJson`
	go clean -testcache
	HISHTORY_FILTERED_TEST=1 TZ='America/Los_Angeles' HISHTORY_TEST=1 HISHTORY_SKIP_INIT_IMPORT=1 gotestsum --packages ./... --rerun-fails=0 --format testname -- -p 1 -run "$(FILTER)" -timeout 60m

fbench:				## Run a specific benchmark test specified via `make fbench FILTER=BenchmarkQuery`
	HISHTORY_FILTERED_TEST=1 TZ='America/Los_Angeles' HISHTORY_TEST=1 HISHTORY_SKIP_INIT_IMPORT=1 go test -benchmem -bench "$(FILTER)" -timeout 60m ./...

backup:				## Backup the local hishtory install. It is recommended to do this before doing any local dev or running any integration tests.
	rm -rf ~/.hishtory.bak || true 
	cp -a ~/.hishtory ~/.hishtory.bak

restore:			## Restore the local hishtory install. If anything goes wrong during local dev or from running integration tests, you can restore the local hishtory install to the last backup.
	rm -rf ~/.hishtory
	mv ~/.hishtory.bak ~/.hishtory

release:			## [ddworken only] Release the latest version on Github
	# Bump the version
	expr `cat VERSION` + 1 > VERSION
	git add VERSION
	git commit -m "Release v0.`cat VERSION`" --no-verify
	git push
	gh release create v0.`cat VERSION` --generate-notes
	git push && git push --tags

build-static:			## [ddworken only] Build the server for hishtory.dev
	ssh server "cd ~/code/hishtory/; git pull; docker build --build-arg GOARCH=amd64 --tag gcr.io/dworken-k8s/hishtory-static --file backend/web/caddy/Dockerfile ."

build-api:			## [ddworken only] Build the API for api.hishtory.dev
	rm hishtory server || true
	docker build --build-arg GOARCH=amd64 --tag gcr.io/dworken-k8s/hishtory-api --file backend/server/Dockerfile .

deploy-static: 			## [ddworken only] Build and deploy the server for hishtory.dev
deploy-static: build-static
	ssh server "docker push gcr.io/dworken-k8s/hishtory-static"
	ssh monoserver "cd ~/code/infra/ && docker compose pull hishtory-static && docker compose rm -svf hishtory-static && docker compose up -d hishtory-static"

deploy-api:			## [ddworken only] Build and deploy the API server for api.hishtory.dev
deploy-api: build-api
	docker push gcr.io/dworken-k8s/hishtory-api
	ssh monoserver "cd ~/code/infra/ && docker compose pull hishtory-api && docker compose up -d --no-deps hishtory-api"

deploy:				## [ddworken only] Build and deploy all backend services
deploy: release deploy-static deploy-api
Make make force all targets to re-run and fix formatting 2024-09-07 02:07:32 +02:00			`MAKEFLAGS += --always-make`

Add 'make help' for #165 2024-02-04 03:09:53 +01:00			`help: ## Show this help.`
			`@fgrep -h "##" $(MAKEFILE_LIST) \| fgrep -v fgrep \| sed -e 's/\\$$//' \| sed -e 's/##//'`

Add make fmt to pre-commit 2024-08-11 21:26:09 +02:00			`fmt: ## Format all files`
run "make fmt" (#233) 2024-08-11 21:19:41 +02:00			`gofumpt -l -w -extra .`
			`gci write --custom-order -s standard -s 'Prefix(github.com/ddworken/hishtory)' -s default .`

Add 'make local-install' for #165 2024-02-04 03:11:20 +01:00			`local-install: ## Build and install hishtory locally from the current directory`
			`go build; ./hishtory install`

Add 'make help' for #165 2024-02-04 03:09:53 +01:00			`forcetest: ## Force running all tests without a test cache`
Refactor tests to make them non-flakey and pass on actions This required adding the ability to have hishtory run synchronously to avoid reconditions. I also added additional waiting code. Also a whole bunch of new tests and disabled gorm's default logger which also caued flakeyness 2022-04-15 05:18:49 +02:00			`go clean -testcache`
Swap to using gotestsum for retrying flaky tests 2023-10-22 00:41:32 +02:00			`make test`
optimize test execution time by only building the client once + add Makefile target for action tests 2022-04-16 03:12:26 +02:00
Add 'make help' for #165 2024-02-04 03:09:53 +01:00			`test: ## Run all tests`
Implement restrictions on default column searching for #268 (#274) * Implement restrictions on default column searching for #268 * Add better docs for config-set excluded-default-search-columns * Enable debugging * Clean up server binaries to avoid wasting disk space * Add tests * Swap from configuring excluded columns to configuring included columns, to prep for future changes where we may add support for other default columns * Reduce gotestsum re-runs since tests are less flaky nowadays * Fix bug in lib.where(...) function that failed to trim the args list and caused DB query correctness issues * Disable tmate debugging * Update goldens 2025-01-18 20:25:07 +01:00			`TZ='America/Los_Angeles' HISHTORY_TEST=1 HISHTORY_SKIP_INIT_IMPORT=1 gotestsum --packages ./... --rerun-fails=5 --rerun-fails-max-failures=15 --format testname --jsonfile /tmp/testrun.json --post-run-command "go run client/posttest/main.go export" -- -p 1 -timeout 90m`
Import cascara landing page and configs for k8s 2022-01-11 03:50:10 +01:00
Add make backup and make restore commands and document them in the contributing section, for #268 2024-12-31 19:22:32 +01:00			ftest: ## Run a specific test specified via `make ftest FILTER=TestParam/testTui/color` or `make ftest FILTER=TestImportJson`
Add clean for the test cache for make ftest target 2022-12-17 06:18:37 +01:00			`go clean -testcache`
Move test goldens to testdata/ directory to be more idiomatic, and add assertion that they're all actively being used by the tests (#154) * Move golden files to testdata dir * Add assertion that requires that all goldens are used * Add map init so the map is non-nil * Add print to confirm that tests finished running * Remove colon so that this doesn't match against gotestsum looking for the substring "panic:", which can happen depending on how stdout is buffer * Revert "Remove colon so that this doesn't match against gotestsum looking for the substring "panic:", which can happen depending on how stdout is buffer" This reverts commit b44e53a17bb1592e620e77e39b7dab93e8edafcf. 2023-12-22 02:06:46 +01:00			`HISHTORY_FILTERED_TEST=1 TZ='America/Los_Angeles' HISHTORY_TEST=1 HISHTORY_SKIP_INIT_IMPORT=1 gotestsum --packages ./... --rerun-fails=0 --format testname -- -p 1 -run "$(FILTER)" -timeout 60m`
Add overall test retries for all tests to make github action tests even more reliable 2023-09-05 04:30:38 +02:00
Add benchmarking for searching for #202 2024-04-14 18:57:44 +02:00			fbench: ## Run a specific benchmark test specified via `make fbench FILTER=BenchmarkQuery`
			`HISHTORY_FILTERED_TEST=1 TZ='America/Los_Angeles' HISHTORY_TEST=1 HISHTORY_SKIP_INIT_IMPORT=1 go test -benchmem -bench "$(FILTER)" -timeout 60m ./...`

Add make backup and make restore commands and document them in the contributing section, for #268 2024-12-31 19:22:32 +01:00			`backup: ## Backup the local hishtory install. It is recommended to do this before doing any local dev or running any integration tests.`
			`rm -rf ~/.hishtory.bak \|\| true`
			`cp -a ~/.hishtory ~/.hishtory.bak`

			`restore: ## Restore the local hishtory install. If anything goes wrong during local dev or from running integration tests, you can restore the local hishtory install to the last backup.`
			`rm -rf ~/.hishtory`
			`mv ~/.hishtory.bak ~/.hishtory`

Add 'make help' for #165 2024-02-04 03:09:53 +01:00			`release: ## [ddworken only] Release the latest version on Github`
Add config for building/releasing binaries for other OSs 2022-04-17 20:44:57 +02:00			`# Bump the version`
fix makefile 2022-04-09 07:57:53 +02:00			expr `cat VERSION` + 1 > VERSION
Fix makefile to run in correct order for deploys to work 2022-04-09 08:07:44 +02:00			`git add VERSION`
Update make release command for new release system 2022-06-05 05:35:01 +02:00			git commit -m "Release v0.`cat VERSION`" --no-verify
run "make fmt" (#233) 2024-08-11 21:19:41 +02:00			`git push`
Add untested update operation that works with the new releases 2022-04-17 21:30:46 +02:00			gh release create v0.`cat VERSION` --generate-notes
Fix downloading the xattr file 2022-04-26 07:21:17 +02:00			`git push && git push --tags`
trying again to make ldflags work with slsa 2022-04-09 07:12:00 +02:00
run "make fmt" (#233) 2024-08-11 21:19:41 +02:00			`build-static: ## [ddworken only] Build the server for hishtory.dev`
docker improvements: * use alpine for small docker images * use docker compose to wait for the database to be ready * use a single Dockerfile with parameters to determine the correct GOARCH * update makefile to account for the new GOARCH parameter on the Dockerfile * remove native-arch-Dockerfile 2023-09-05 20:52:46 +02:00			`ssh server "cd ~/code/hishtory/; git pull; docker build --build-arg GOARCH=amd64 --tag gcr.io/dworken-k8s/hishtory-static --file backend/web/caddy/Dockerfile ."`
still horribly broken, just a commit before refactoring to move http handlers onto a struct 2022-04-03 07:27:20 +02:00
run "make fmt" (#233) 2024-08-11 21:19:41 +02:00			`build-api: ## [ddworken only] Build the API for api.hishtory.dev`
Fix memory leak caused by not closing resp.Body (#62) and also fix the server to work when the DD integration is disabled 2022-12-24 02:17:44 +01:00			`rm hishtory server \|\| true`
docker improvements: * use alpine for small docker images * use docker compose to wait for the database to be ready * use a single Dockerfile with parameters to determine the correct GOARCH * update makefile to account for the new GOARCH parameter on the Dockerfile * remove native-arch-Dockerfile 2023-09-05 20:52:46 +02:00			`docker build --build-arg GOARCH=amd64 --tag gcr.io/dworken-k8s/hishtory-api --file backend/server/Dockerfile .`
Import cascara landing page and configs for k8s 2022-01-11 03:50:10 +01:00
run "make fmt" (#233) 2024-08-11 21:19:41 +02:00			`deploy-static: ## [ddworken only] Build and deploy the server for hishtory.dev`
still horribly broken, just a commit before refactoring to move http handlers onto a struct 2022-04-03 07:27:20 +02:00			`deploy-static: build-static`
Rewrite makefile for deploy-static to work from my arm macbook. The docker compose rm is needed because hishtory-static has a volume that was getting reused 2023-03-01 06:22:35 +01:00			`ssh server "docker push gcr.io/dworken-k8s/hishtory-static"`
Update makefile deploy path 2024-09-04 06:18:54 +02:00			`ssh monoserver "cd ~/code/infra/ && docker compose pull hishtory-static && docker compose rm -svf hishtory-static && docker compose up -d hishtory-static"`
still horribly broken, just a commit before refactoring to move http handlers onto a struct 2022-04-03 07:27:20 +02:00
run "make fmt" (#233) 2024-08-11 21:19:41 +02:00			`deploy-api: ## [ddworken only] Build and deploy the API server for api.hishtory.dev`
still horribly broken, just a commit before refactoring to move http handlers onto a struct 2022-04-03 07:27:20 +02:00			`deploy-api: build-api`
			`docker push gcr.io/dworken-k8s/hishtory-api`
Update makefile deploy path 2024-09-04 06:18:54 +02:00			`ssh monoserver "cd ~/code/infra/ && docker compose pull hishtory-api && docker compose up -d --no-deps hishtory-api"`
refactoring, better tests, commit hash, banner, and tested working locally 2022-04-07 07:43:07 +02:00
run "make fmt" (#233) 2024-08-11 21:19:41 +02:00			`deploy: ## [ddworken only] Build and deploy all backend services`
Fix makefile to run in correct order for deploys to work 2022-04-09 08:07:44 +02:00			`deploy: release deploy-static deploy-api`