Merge pull request #62 from ivanilves/issues-22

docs(issues/22): Add help instructions to the Makefile

Author: ivanilves

.github/workflows/ci.yml

@@ -1,7 +1,7 @@
 name: CI
 
 env:
-  GO_VERSION: 1.22
+  GO_VERSION: 1.24
 
 on:
   push:

.github/workflows/release.yml

@@ -1,7 +1,7 @@
 name: Release
 
 env:
-  GO_VERSION: 1.22
+  GO_VERSION: 1.24
 
 on:
   push:

Makefile

@@ -10,43 +10,44 @@ SHELL := /bin/bash
 
 -include local.mk
 
-default: dep build
+help: ## Print this helpful message
+	@grep -E '^[a-zA-Z0-9_-]+:.*?\#\# .*$$' Makefile | awk 'BEGIN {FS = ":.*?\#\# "}; {printf "\033[36m%-21s\033[0m %s\n", $$1, $$2}'
 
-all: dep build test install
+all: dep build test install ## Bootstrap, build, test and install travelgrunt locally
 
-deploy: build install
+deploy: build install ## Build and install travelgrunt locally
 
-dep:
+dep: ## Bootstrap the project AKA install/manage Golang dependencies
 	go mod tidy
 	go mod vendor
 
-build:
+build: ## Build the travelgrunt application
 	cd ${BUILD_PATH} && go build -tags netgo,osusergo
 
-test:
+test: ## Test the travelgrunt application
 	go test -v ./...
 
-golangci-lint:
+golangci-lint: ## Run the linter: golangci-lint
 	golangci-lint run -v ./...
 
-golint:
+golint: ## Run the linter: golint
 	golint ./...
 
-lint: golangci-lint golint
+lint: golangci-lint golint ## Run all the linters
 
-vet:
+vet: ## Analyze code for suspicious constructs
 	go vet ./...
 
-staticcheck:
+staticcheck: ## Run staticcheck, a state of the art linter
 	staticcheck ./...
 
-coverage:
+coverage: ## Create test coverage report
 	go test ./... -race -coverprofile=coverage.out -covermode=atomic
 
-clean:
+clean: ## Cleanup the build artifacts
 	git clean -fdx
 
-install: PREFIX ?= /usr/local
+install: PREFIX ?= /usr/local ## Install travelgrunt binary under PREFIX
 install:
 	install ${BUILD_PATH}/travelgrunt ${PREFIX}/bin/
 
@@ -62,7 +63,7 @@ pull-git-branch:
 next-version-tag:
 	git tag ${NEXT_VERSION} && git push --tags
 
-release: check-git-branch pull-git-branch next-version-tag
+release: check-git-branch pull-git-branch next-version-tag ## Release new version of travelgrunt
 
 semantic-commit-check: RANGE ?= main..HEAD
 semantic-commit-check: REGEX := "^(feat|fix|refactor|chore|test|style|docs)(\([a-zA-Z0-9\/_-]+\))?: [a-zA-Z]"

README.md

@@ -8,8 +8,6 @@ Travel **[Terragrunt](https://terragrunt.gruntwork.io/)**, **[Terraform](https:/
 
 `travelgrunt` alleviates the pain of hitting endless `cd`/`<TAB>` combos while navigating inside the repo.
 
-:bulb: Video with a brief introduction and a demo is available [here](https://www.youtube.com/watch?v=iqKDJZhfjj4) :movie_camera:
-
 ## How to use?
 
 * `cd` to the directory of your [locally cloned] Git repository;

go.mod

@@ -1,43 +1,40 @@
 module github.com/ivanilves/travelgrunt
 
-go 1.21
+go 1.24.2
 
 require (
-	github.com/fatih/color v1.17.0
-	github.com/go-git/go-git/v5 v5.9.0
+	github.com/fatih/color v1.18.0
+	github.com/go-git/go-git/v5 v5.16.0
 	github.com/manifoldco/promptui v0.9.0
-	github.com/stretchr/testify v1.8.4
-	golang.org/x/exp v0.0.0-20230905200255-921286631fa9
-	golang.org/x/term v0.12.0
+	github.com/stretchr/testify v1.10.0
+	golang.org/x/exp v0.0.0-20250408133849-7e4ce0ab07d0
+	golang.org/x/term v0.31.0
 	gopkg.in/yaml.v3 v3.0.1
 )
 
 require (
 	dario.cat/mergo v1.0.0 // indirect
-	github.com/Microsoft/go-winio v0.6.1 // indirect
-	github.com/ProtonMail/go-crypto v0.0.0-20230828082145-3c4c8a2d2371 // indirect
-	github.com/acomagu/bufpipe v1.0.4 // indirect
+	github.com/Microsoft/go-winio v0.6.2 // indirect
+	github.com/ProtonMail/go-crypto v1.1.6 // indirect
 	github.com/chzyer/readline v0.0.0-20180603132655-2972be24d48e // indirect
-	github.com/cloudflare/circl v1.3.3 // indirect
-	github.com/cyphar/filepath-securejoin v0.2.4 // indirect
+	github.com/cloudflare/circl v1.6.1 // indirect
+	github.com/cyphar/filepath-securejoin v0.4.1 // indirect
 	github.com/davecgh/go-spew v1.1.1 // indirect
 	github.com/emirpasic/gods v1.18.1 // indirect
 	github.com/go-git/gcfg v1.5.1-0.20230307220236-3a3c6141e376 // indirect
-	github.com/go-git/go-billy/v5 v5.5.0 // indirect
-	github.com/golang/groupcache v0.0.0-20210331224755-41bb18bfe9da // indirect
+	github.com/go-git/go-billy/v5 v5.6.2 // indirect
+	github.com/golang/groupcache v0.0.0-20241129210726-2c02b8208cf8 // indirect
 	github.com/jbenet/go-context v0.0.0-20150711004518-d14ea06fba99 // indirect
 	github.com/kevinburke/ssh_config v1.2.0 // indirect
 	github.com/mattn/go-colorable v0.1.13 // indirect
 	github.com/mattn/go-isatty v0.0.20 // indirect
-	github.com/pjbgf/sha1cd v0.3.0 // indirect
+	github.com/pjbgf/sha1cd v0.3.2 // indirect
 	github.com/pmezard/go-difflib v1.0.0 // indirect
-	github.com/sergi/go-diff v1.1.0 // indirect
-	github.com/skeema/knownhosts v1.2.0 // indirect
+	github.com/sergi/go-diff v1.3.2-0.20230802210424-5b0b94c5c0d3 // indirect
+	github.com/skeema/knownhosts v1.3.1 // indirect
 	github.com/xanzy/ssh-agent v0.3.3 // indirect
-	golang.org/x/crypto v0.13.0 // indirect
-	golang.org/x/mod v0.12.0 // indirect
-	golang.org/x/net v0.15.0 // indirect
-	golang.org/x/sys v0.18.0 // indirect
-	golang.org/x/tools v0.13.0 // indirect
+	golang.org/x/crypto v0.37.0 // indirect
+	golang.org/x/net v0.39.0 // indirect
+	golang.org/x/sys v0.32.0 // indirect
 	gopkg.in/warnings.v0 v0.1.2 // indirect
 )