chore: migrate to taskfile

.githooks/pre-push

@@ -18,4 +18,4 @@ function failed {
 
 trap 'failed' ERR
 
-make lint
+task lint

.gitignore

@@ -2,13 +2,15 @@
 # Project #
 ###########
 
-# make output
-bin/
+# build files
+build/
 out/
+.task
 
 # test projects
 awesome-project/
 testing-project/
+test-project/
 
 ##########
 # Golang #

Makefile

@@ -1,63 +1,6 @@
-SHELL=/bin/bash -e -o pipefail
-PWD = $(shell pwd)
-LINTER_VERSION = v1.55.1
-
-all: git-hooks generate ## Initializes all tools and files
-
-out:
-	@mkdir -pv "$(@)"
-
-test-build: ## Tests whether the code compiles
-	@go build -o /dev/null ./...
-
-build: out/bin ## Builds all binaries
-
-GO_BUILD = mkdir -pv "$(@)" && go build -ldflags="-w -s" -o "$(@)" ./...
-.PHONY: out/bin
-out/bin:
-	$(GO_BUILD)
-
-git-hooks:
-	@git config --local core.hooksPath .githooks/
-
-download: ## Downloads the dependencies
-	@go mod download
-
-fmt: ## Formats all code with go fmt
-	@go fmt ./...
-
-run: fmt ## Run a controller from your host
-	@go run ./main.go
-
-generate: ## Generates files
-	@go run cmd/options2md/main.go -o docs/options.md
-
-
-lint: fmt download ## Lints all code with golangci-lint
-	@go run -v github.com/golangci/golangci-lint/cmd/golangci-lint@$(LINTER_VERSION) run
-
-govulncheck: ## Vulnerability detection using govulncheck
-	@go run golang.org/x/vuln/cmd/govulncheck ./...
-
-test: ## Runs all tests
-	@go test ./...
-
-coverage: out/report.json ## Displays coverage per func on cli
-	go tool cover -func=out/cover.out
-
-html-coverage: out/report.json ## Displays the coverage results in the browser
-	go tool cover -html=out/cover.out
-
-test-coverage: out ## Creates a test coverage profile
-	go test -v -cover ./... -coverprofile out/coverage.out -coverpkg ./...
-	go tool cover -func out/coverage.out -o out/coverage.out
-
 clean-test-project: ## Removes test-project
 	@rm -rf testing-project
 
-clean: clean-test-project ## Cleans up everything
-	@rm -rf bin out
-
 .PHONY: testing-project
 testing-project: clean-test-project ## Creates a testing-project from the template
 	@go run cmd/gt/*.go new -c $$VALUES_FILE
@@ -77,16 +20,3 @@ testing-project-ci:  ## Creates for all yml files in ./test_project_values a tes
 	for VALUES in ./test_project_values/*.yml; do \
 		make testing-project-ci-single VALUES_FILE=$$VALUES; \
 	done
-
-.PHONY: release
-release:  ## Create a new release version
-	@./hack/release.sh
-
-help:
-	@echo 'Usage: make <OPTIONS> ... <TARGETS>'
-	@echo ''
-	@echo 'Available targets are:'
-	@echo ''
-	@grep -E '^[ a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | \
-	awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}'
-	@echo ''

Taskfile.yml

@@ -0,0 +1,91 @@
+version: "3"
+
+vars:
+  LINTER_VERSION: v1.55.1
+  BUILD_DIR: ./build/
+  TEST_PROJECT_DIR: ./test-project/
+
+tasks:
+  build:
+    desc: Builds the project
+    sources:
+      - "**/*.go"
+    cmds:
+      - go build -o {{.BUILD_DIR}} ./...
+    generates:
+      - build/gt
+      - build/options2md
+
+  run:
+    desc: Builds and runs gt (cleans test project output before)
+    deps:
+      - build
+    cmds:
+      - rm -rf {{.TEST_PROJECT_DIR}}
+      - build/gt
+    generates:
+      - build/gt
+
+  clean:
+    desc: Removes artifacts
+    cmds:
+      - rm -rf {{.BUILD_DIR}}
+      - rm -rf {{.TEST_PROJECT_DIR}}
+
+  lint:
+    desc: Lints the project
+    cmds:
+      - go run -v github.com/golangci/golangci-lint/cmd/golangci-lint@{{.LINTER_VERSION}} run
+
+  test:
+    desc: Runs all automated tests
+    cmds:
+      - go test ./...
+
+  test-build:
+    desc: Tests if the project can be built
+    cmds:
+      - go build -o /dev/null ./...
+
+  coverage:
+    desc: Generates test coverage report
+    cmds:
+      - go test -v -cover ./... -coverprofile out/coverage.out -coverpkg ./...
+      - go tool cover -func out/coverage.out -o out/coverage.out
+    generates:
+      - out/coverage.out
+
+  generate:
+    desc: Regenerates generated files
+    cmds:
+      - go run cmd/options2md/main.go -o docs/options.md
+    generates:
+      - docs/options.md
+
+  release:
+    desc: Creates a new release
+    prompt: Are you sure you want to create a new release?
+    deps:
+      - lint
+      - test
+    cmds:
+      - hack/release.sh
+
+  setup:
+    desc: Set up the project
+    cmds:
+      - git config --local core.hooksPath .githooks/
+      - go mod download
+
+  create-test-project:
+    desc: Creates a preconfigured test project
+    aliases:
+      - test-project
+      - tp
+    vars:
+      CONFIG_FILE: testdata/default.yml
+    deps:
+      - build
+    cmds:
+      - rm -rf {{.TEST_PROJECT_DIR}}
+      - go run cmd/gt/*.go new -c {{.CONFIG_FILE}}

testdata/ci_case_0.yml

@@ -0,0 +1,9 @@
+base:
+  projectName: Test Project
+  projectSlug: test-project
+  projectDescription: Some project used for testing
+  appName: test
+  moduleName: github.com/fake/test
+extensions:
+  ci:
+    provider: 0 # No CI

testdata/ci_case_1.yml

@@ -0,0 +1,9 @@
+base:
+  projectName: Test Project
+  projectSlug: test-project
+  projectDescription: Some project used for testing
+  appName: test
+  moduleName: github.com/fake/test
+extensions:
+  ci:
+    provider: 1 # Github

testdata/ci_case_2.yml

@@ -0,0 +1,9 @@
+base:
+  projectName: Test Project
+  projectSlug: test-project
+  projectDescription: Some project used for testing
+  appName: test
+  moduleName: github.com/fake/test
+extensions:
+  ci:
+    provider: 2 #Gitlab

testdata/ci_case_3.yml

@@ -0,0 +1,9 @@
+base:
+  projectName: Test Project
+  projectSlug: test-project
+  projectDescription: Some project used for testing
+  appName: test
+  moduleName: github.com/fake/test
+extensions:
+  ci:
+    provider: 3 # Azure DevOps

testdata/default.yml

@@ -0,0 +1,16 @@
+base:
+  projectName: Test Project
+  projectSlug: test-project
+  projectDescription: Some project used for testing
+  appName: testing
+  moduleName: github.com/fake/test
+extensions:
+  openSource:
+    author: "Marty Mc Fly"
+    codeowner: "[email protected]"
+    license: 1 # MIT License
+  ci:
+    provider: 1
+  grpc:
+    base: true
+    grpcGateway: false

testdata/grpc_with_gateway.yml

@@ -0,0 +1,10 @@
+base:
+  projectName: Test Project
+  projectSlug: test-project
+  projectDescription: Some project used for testing
+  appName: test
+  moduleName: github.com/fake/test
+extensions:
+  grpc:
+    base: true
+    grpcGateway: true

test_project_values/grpc_without_gateway.yml → testdata/grpc_without_gateway.yml

@@ -1,9 +1,9 @@
 base:
-  projectName: Testing Project
-  projectSlug: testing-project
+  projectName: Test Project
+  projectSlug: test-project
   projectDescription: Some project used for testing
-  appName: testing
-  moduleName: github.com/fake/testing
+  appName: test
+  moduleName: github.com/fake/test
 extensions:
   openSource:
     author: "Marty Mc Fly"

testdata/no_extentions.yml

@@ -0,0 +1,6 @@
+base:
+  projectName: Test Project
+  projectSlug: test-project
+  projectDescription: Some project used for testing
+  appName: test
+  moduleName: github.com/fake/test

test_project_values/open_source.yml → testdata/open_source.yml

@@ -1,9 +1,9 @@
 base:
-  projectName: Testing Project
-  projectSlug: testing-project
+  projectName: Test Project
+  projectSlug: test-project
   projectDescription: Some project used for testing
-  appName: testing
-  moduleName: github.com/fake/testing
+  appName: test
+  moduleName: github.com/fake/test
 extensions:
   openSource:
     author: "Marty Mc Fly"