Adjust project structure

Author: bcessa

.github/workflows/ci.yml

@@ -8,6 +8,8 @@ on:
       - master
   workflow_dispatch: {}
 jobs:
+  # Runs on every push and pull request on the selected branches.
+  # Can also be executed manually.
   test:
     name: code quality and correctness
     runs-on: ubuntu-latest
@@ -23,7 +25,7 @@ jobs:
       - name: Checkout repository
         uses: actions/checkout@v2
 
-      # Configure runner environment
+      # Prepare runner environment
       - name: Set up runner environment
         run: ./.github/workflows/assets/utils.sh setup
         env:
@@ -33,7 +35,7 @@ jobs:
       # If "vendor" is in cache, restore.
       # To run conditional steps use:
       # if: steps.vendor-cache.outputs.cache-hit != 'true'
-      - name: Restore modules from cache
+      - name: Restore vendor from cache
         id: vendor-cache
         uses: actions/cache@v2
         env:
@@ -55,7 +57,7 @@ jobs:
 
       # Ensure project compile and build successfully
       - name: Build
-        run: make build
+        run: make build-for os=linux arch=amd64
 
       # Save artifacts
       - name: Save artifacts

.github/workflows/release.yml

@@ -2,14 +2,14 @@ name: release
 on:
   push:
     tags:
-      - v*
+      - '*'
 jobs:
   # Publish project package(s)
   publish:
     name: publish package
     runs-on: ubuntu-latest
     timeout-minutes: 10
-    if: ${{ contains(github.ref, 'refs/tags/') }}
+    if: startsWith(github.ref, 'refs/tags/')
     steps:
       # Go 1.14
       - name: Set up Go 1.14
@@ -33,7 +33,7 @@ jobs:
       # If "vendor" is in cache, restore.
       # To run conditional steps use:
       # if: steps.vendor-cache.outputs.cache-hit != 'true'
-      - name: Restore modules from cache
+      - name: Restore vendor from cache
         id: vendor-cache
         uses: actions/cache@v2
         env:
@@ -42,10 +42,14 @@ jobs:
           path: ./vendor
           key: ${{ env.cache-name }}-${{ hashFiles('go.sum') }}
 
+      # Ensure project compile and build successfully
+      - name: Build
+        run: make build-for os=linux arch=amd64
+
       # Use goreleaser to create the new release
       - name: Create release
         uses: goreleaser/goreleaser-action@v2
-        if: startsWith(github.ref, 'refs/tags/v')
+        if: startsWith(github.ref, 'refs/tags/')
         with:
           version: latest
           args: release --rm-dist --skip-validate

Makefile

@@ -3,11 +3,12 @@
 
 # Project setup
 BINARY_NAME=tredctl
+MAINTAINERS='Ben Cessa <ben@pixative.com>'
 
 # State values
 GIT_COMMIT_DATE=$(shell TZ=UTC git log -n1 --pretty=format:'%cd' --date='format-local:%Y-%m-%dT%H:%M:%SZ')
 GIT_COMMIT_HASH=$(shell git log -n1 --pretty=format:'%H')
-GIT_TAG=$(shell git describe --abbrev=0 --match='v*' --always | cut -c 1-8)
+GIT_TAG=$(shell git describe --tags --always --abbrev=0 | cut -c 1-8)
 
 # Linker tags
 # https://golang.org/cmd/link/
@@ -21,15 +22,16 @@ help:
 	@echo "Commands available"
 	@sed -n 's/^##//p' ${MAKEFILE_LIST} | column -t -s ':' | sed -e 's/^/ /' | sort
 
-## updates: List available updates for direct dependencies
-updates:
-	# https://github.com/golang/go/wiki/Modules#how-to-upgrade-and-downgrade-dependencies
-	go list -u -f '{{if (and (not (or .Main .Indirect)) .Update)}}{{.Path}}: {{.Version}} -> {{.Update.Version}}{{end}}' -m all 2> /dev/null
+## build: Build for the default architecture in use
+build:
+	go build -v -ldflags '$(LD_FLAGS)' -o $(BINARY_NAME)
 
-## scan: Look for known vulnerabilities in the project dependencies
-# https://github.com/sonatype-nexus-community/nancy
-scan:
-	@nancy -quiet go.sum
+## build-for: Build the available binaries for the specified 'os' and 'arch'
+# make build-for os=linux arch=amd64
+build-for:
+	CGO_ENABLED=0 GOOS=$(os) GOARCH=$(arch) \
+	go build -v -ldflags '$(LD_FLAGS)' \
+	-o $(BINARY_NAME)_$(os)_$(arch)$(suffix)
 
 ## clean: Verify dependencies and remove intermediary products
 clean:
@@ -38,29 +40,29 @@ clean:
 	go mod tidy
 	go mod verify
 
+## install: Install the binary to '$GOPATH/bin'
+install:
+	go build -v -ldflags '$(LD_FLAGS)' -i -o ${GOPATH}/bin/$(BINARY_NAME)
+
 ## lint: Static analysis
 lint:
 	golangci-lint run -v ./...
 
+## release: Prepare the artifacts for a new tagged release
+release:
+	goreleaser release --skip-validate --skip-publish --rm-dist
+
+## scan: Look for known vulnerabilities in the project dependencies
+# https://github.com/sonatype-nexus-community/nancy
+scan:
+	@nancy -quiet go.sum
+
 ## test: Run unit tests excluding the vendor dependencies
 test:
 	go test -v -race -failfast -coverprofile=coverage.report ./...
 	go tool cover -html coverage.report -o coverage.html
 
-## build: Build for the default architecture in use
-build:
-	go build -v -ldflags '$(LD_FLAGS)' -o $(BINARY_NAME)
-
-## install: Install the binary to '$GOPATH/bin'
-install:
-	go build -v -ldflags '$(LD_FLAGS)' -i -o ${GOPATH}/bin/$(BINARY_NAME)
-
-## build-for: Build the available binaries for the specified 'os' and 'arch'
-build-for:
-	CGO_ENABLED=0 GOOS=$(os) GOARCH=$(arch) \
-	go build -v -ldflags '$(LD_FLAGS)' \
-	-o $(BINARY_NAME)_$(os)_$(arch)$(suffix)
-
-## release: Prepare the artifacts for a new tagged release
-release:
-	goreleaser release --skip-validate --skip-publish --rm-dist
+## updates: List available updates for direct dependencies
+updates:
+	# https://github.com/golang/go/wiki/Modules#how-to-upgrade-and-downgrade-dependencies
+	go list -u -f '{{if (and (not (or .Main .Indirect)) .Update)}}{{.Path}}: {{.Version}} -> {{.Update.Version}}{{end}}' -m all 2> /dev/null