feat: add version and cobra command

.github/CODEOWNERS

@@ -0,0 +1,9 @@
+# CODEOWNERS: https://help.github.com/articles/about-codeowners/
+
+# Primary repo maintainers
+*       @ilgooz @jeronimoalbi @Pantani @julienrbrt
+
+# Docs
+*.md    @salmad3 @toschdev @ilgooz
+docs/*   @salmad3 @toschdev @ilgooz
+changelog.md @ilgooz @salmad3 @toschdev @jeronimoalbi @Pantani @julienrbrt

.github/workflows/release-docker.yml

@@ -13,7 +13,7 @@ jobs:
         uses: docker/setup-buildx-action@v1
 
       - name: Login to GitHub Container Registry
-        uses: docker/login-action@v1
+        uses: docker/login-action@v2
         with:
           registry: ghcr.io
           username: ${{ github.repository_owner }}
@@ -25,7 +25,7 @@ jobs:
 
       - name: Build and push
         id: docker_build
-        uses: docker/build-push-action@v2
+        uses: docker/build-push-action@v3
         with:
           push: true
           platforms: linux/amd64,linux/arm64

.github/workflows/release.yml

@@ -10,19 +10,19 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
         with:
           fetch-depth: 0
 
       - name: Set up Go
-        uses: actions/setup-go@v2
+        uses: actions/setup-go@v5
         with:
-          go-version: 1.16
+          go-version: "stable"
 
       - name: Run GoReleaser
         uses: goreleaser/goreleaser-action@v2
         with:
-          version: latest
+          version: 1.13.0
           args: release --rm-dist
         env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/semantic-pull-request.yml

@@ -1,14 +1,20 @@
 name: "Semantic PR"
+
 on:
   pull_request_target:
     types:
       - opened
       - edited
       - synchronize
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
+  cancel-in-progress: true
+
 jobs:
   main:
     runs-on: ubuntu-latest
     steps:
-      - uses: amannn/action-semantic-pull-request@v1.2.0
+      - uses: amannn/action-semantic-pull-request@v5
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/test.yml

@@ -1,13 +1,23 @@
 name: Test
 
-on: [push]
+on:
+  pull_request:
+  push:
+    branches:
+      - main
+      - master
+      - release/*
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
+  cancel-in-progress: true
 
 jobs:
   test:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-go@v2
+      - uses: actions/checkout@v4
+      - uses: actions/setup-go@v5
         with:
-          go-version: 1.16
+          go-version: "stable"
       - run: make test

.goreleaser.yml

@@ -1,8 +1,8 @@
 builds:
   - main: ./cmd/faucet
+    goos:
+      - linux
+      - darwin
     goarch:
       - amd64
       - arm64
-    ignore:
-      - goos: darwin
-        goarch: arm64

Makefile

@@ -1,21 +1,111 @@
-BUILDDIR ?= $(CURDIR)/build
+PROJECT_NAME = Faucet
+FIND_ARGS := -name '*.go' -type f
+PACKAGES=$(shell go list ./...)
+VERSION := $(shell echo $(shell git describe --tags 2> /dev/null || echo "dev-$(shell git describe --always)") | sed 's/^v//')
+COVER_FILE := coverage.txt
+COVER_HTML_FILE := cover.html
 
-all: install
+export GO111MODULE = on
 
-$(BUILDDIR)/:
-	mkdir -p $@
+###############################################################################
+###                                  Test                                   ###
+###############################################################################
 
-BUILD_TARGETS := build install
-build: $(BUILDDIR)/
-build: BUILD_ARGS=-o=$(BUILDDIR)
+## test-unit: Run the unit tests.
+test-unit:
+	@echo Running unit tests...
+	@VERSION=$(VERSION) go test -mod=readonly -v -timeout 30m $(PACKAGES)
 
-$(BUILD_TARGETS):
-	go $@ -mod=readonly $(BUILD_FLAGS) $(BUILD_ARGS) ./...
+## test-race: Run the unit tests checking for race conditions
+test-race:
+	@echo Running unit tests with race condition reporting...
+	@VERSION=$(VERSION) go test -mod=readonly -v -race -timeout 30m  $(PACKAGES)
 
-test:
-	go test ./...
+## test-cover: Run the unit tests and create a coverage html report
+test-cover:
+	@echo Running unit tests and creating coverage report...
+	@VERSION=$(VERSION) go test -mod=readonly -v -timeout 30m -coverprofile=$(COVER_FILE) -covermode=atomic $(PACKAGES)
+	@go tool cover -html=$(COVER_FILE) -o $(COVER_HTML_FILE)
+	@rm $(COVER_FILE)
+
+## bench: Run the unit tests with benchmarking enabled
+bench:
+	@echo Running unit tests with benchmarking...
+	@VERSION=$(VERSION) go test -mod=readonly -v -timeout 30m -bench=. $(PACKAGES)
+
+## test: Run unit and integration tests.
+test: govet govulncheck test-unit
+
+.PHONY: test test-unit test-race test-cover bench
+
+###############################################################################
+###                                  Build                                  ###
+###############################################################################
+
+build: go.sum
+ifeq ($(OS),Windows_NT)
+	go build -o build/faucet.exe .
+else
+	go build -o build/faucet .
+endif
+
+build-linux: go.sum
+	LEDGER_ENABLED=false GOOS=linux GOARCH=amd64 $(MAKE) build
+
+install: go.sum
+	go install .
+
+###############################################################################
+###                          Tools & Dependencies                           ###
+###############################################################################
+
+go-mod-cache: go.sum
+	@echo "--> Download go modules to local cache"
+	@go mod download
+
+go.sum: go.mod
+	@echo "--> Ensure dependencies have not been modified"
+	@go mod verify
+	@go mod tidy
 
 clean:
-	rm -rf $(BUILDDIR)/
+	rm -rf build/
+
+.PHONY: go-mod-cache clean
+
+###############################################################################
+###                               Development                               ###
+###############################################################################
+
+## govet: Run go vet.
+govet:
+	@echo Running go vet...
+	@go vet $(shell go list ./...)
+
+## govulncheck: Run govulncheck
+govulncheck:
+	@echo Running govulncheck...
+	@go run golang.org/x/vuln/cmd/govulncheck ./...
+
+## format: Run gofumpt and goimports.
+format:
+	@echo Formatting...
+	@go install mvdan.cc/gofumpt
+	@go install golang.org/x/tools/cmd/goimports
+	@find . $(FIND_ARGS) | xargs gofumpt -w .
+	@find . $(FIND_ARGS) | xargs goimports -w -local github.com/ignite/network
+
+## lint: Run Golang CI Lint.
+lint:
+	@echo Running gocilint...
+	@go install github.com/golangci/golangci-lint/cmd/golangci-lint
+	@golangci-lint run --out-format=tab --issues-exit-code=0
+
+help: Makefile
+	@echo
+	@echo " Choose a command run in "$(PROJECT_NAME)", or just run 'make' for install"
+	@echo
+	@sed -n 's/^##//p' $< | column -t -s ':' |  sed -e 's/^/ /'
+	@echo
 
-.PHONY: all $(BUILD_TARGETS) clean
+.PHONY: lint format govet govulncheck help

README.md

@@ -58,22 +58,22 @@ $ make install
 You can configure the faucet either using command line flags or environment variables. The following table
 shows the available configuration options and respective defaults:
 
-| flag                | env               | description                                                   | default   |
-|---------------------|-------------------|-------------------------------------------------------------- |-----------|
-| port                | PORT              | tcp port where faucet will be listening for requests          | 8000      |
-| account-name        | ACCOUNT_NAME      | name of the account to be used by the faucet                  | faucet    |
-| mnemonic            | MNEMONIC          | mnemonic for restoring an account                             |           |
-| keyring-password    | KEYRING_PASSWORD  | password for accessing keyring                                |           |
-| cli-name            | DENOMS            | denomination of the coins sent by default (comma separated)   | uatom     |
-| credit-amount       | CREDIT_AMOUNT     | amount to credit in each request                              | 10000000  |
-| max-credit          | MAX_CREDIT        | maximum credit per account                                    | 100000000 |
-| sdk-version         | SDK_VERSION       | version of sdk (launchpad or stargate)                        | stargate  |
-| node                | NODE              | address of tendermint RPC endpoint for this chain             |           |
-| keyring-backend     | KEYRING_BACKEND   | keyring backend to be used                                    |           |
-| legacy-send         | LEGACY_SEND       | whether to use legacy send command                            | false     |
-| coin-type           | COIN_TYPE         | registered coin type number for HD derivation (BIP-0044)      | 118       |
-| home                | HOME              | replaces the default home used by the chain                   |           |
-|                     |                   |                                                               |           |
+| flag             | env              | description                                                   | default   |
+|------------------|------------------|-------------------------------------------------------------- |-----------|
+| port             | PORT             | tcp port where faucet will be listening for requests          | 8000      |
+| account-name     | ACCOUNT_NAME     | name of the account to be used by the faucet                  | faucet    |
+| mnemonic         | MNEMONIC         | mnemonic for restoring an account                             |           |
+| keyring-password | KEYRING_PASSWORD | password for accessing keyring                                |           |
+| denoms           | DENOMS           | denomination of the coins sent by default (comma separated)   | uatom     |
+| credit-amount    | CREDIT_AMOUNT    | amount to credit in each request                              | 10000000  |
+| max-credit       | MAX_CREDIT       | maximum credit per account                                    | 100000000 |
+| fee-amount       | FEE_AMOUNT       | fee to pay along with the transaction                                    | 0         |
+| sdk-version      | SDK_VERSION      | version of sdk (launchpad or stargate)                        | stargate  |
+| node             | NODE             | address of tendermint RPC endpoint for this chain             |           |
+| keyring-backend  | KEYRING_BACKEND  | keyring backend to be used                                    |           |
+| coin-type        | COIN_TYPE        | registered coin type number for HD derivation (BIP-0044)      | 118       |
+| home             | HOME             | replaces the default home used by the chain                   |           |
+|                  |                  |                                                               |           |
 
 ### [gaia](https://github.com/cosmos/gaia) example