Merge pull request #10 from danielvrog/main

Add Makefile and Dockefile

.github/workflows/golang-build-test-coverage.yml

@@ -1,12 +1,11 @@
 name: golang-build-test-coverage
-# TODO: build on MR and merge to master
 on:
   push:
      branches-ignore:
-      - master
+      - main
   pull_request:
     branches:    
-      - master
+      - main
   release:
 
 jobs:

.gitignore

@@ -1,3 +1,4 @@
 main
 main.tmpl
 config
+bin/*

Dockerfile

@@ -0,0 +1,13 @@
+ARG GO_VERSION=1.16
+FROM golang:${GO_VERSION} AS builder
+COPY . /terra-crust
+WORKDIR /terra-crust
+RUN make compile
+
+
+FROM golang:${GO_VERSION}
+ARG ARCH=amd64
+WORKDIR /opt/
+COPY --from=builder /terra-crust/bin/terra-crust-linux-${ARCH} ./
+RUN mv terra-crust-linux-${ARCH} terra-crust
+CMD ["./terra-crust"]  

Makefile

@@ -0,0 +1,55 @@
+SHELL := /bin/bash
+ROOT_DIR:=$(shell dirname $(realpath $(lastword $(MAKEFILE_LIST))))
+
+export GO_VERSION ?= $(shell grep -E "^go " go.mod | awk -F' ' '{print $$2}' )
+export GOLANGCI_LINT_VERSION=v1.41.1
+export MAIN_GO=internal/cmd/main.go
+
+.PHONY: help
+help: ## Show this help message.
+
+	@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}'
+
+
+get-go-dependancies: 	## Get dependancies as devlared in the project 
+	$(info)
+	$(info ========[ $@ ]========)
+	go get -v -t -d ./...
+
+get-linter:		## Get golangci-lint
+	$(info)
+	$(info ========[ $@ ]========)
+	@if ! golangci-lint --version 2>/dev/null; then \
+		curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b $(go env GOPATH)/bin ${GOLANGCI_LINT_VERSION};\
+	fi;\
+
+lint: get-linter ## Run linter
+	$(info)
+	$(info ========[ $@ ]========)
+	golangci-lint run --fast --enable-all -D scopelint -D gocyclo -D godot -D funlen -D lll -D gocognit -D gofumpt -D wsl -D gomnd --skip-dirs-use-default
+
+test: ## Run go tests
+	$(info)
+	$(info ========[ $@ ]========)
+	go test ./...	
+
+build: get-go-dependancies lint ## Build
+	$(info)
+	$(info ========[ $@ ]========)
+	go build -v ${MAIN_GO}
+
+
+compile: build ## Compile binaries for multiple OSs and architectures
+	$(info)
+	$(info ========[ $@ ]========)
+	@for os in "linux" "darwin"; do \
+		for arch in "amd64" "arm64"; do \
+			echo "$${os} - $${arch}"; \
+			GOOS=$${os} GOARCH=$${arch} go build -o bin/terra-crust-$${os}-$${arch} ${MAIN_GO}; \
+		done \
+	done
+
+build-docker: ## Build a docker image
+	$(info)
+	$(info ========[ $@ ]========)
+	docker build -t appsflyer/terra-crust:$$(git rev-parse --short HEAD) .

README.md

@@ -1,3 +1,5 @@
+![Build](https://github.com/danielvrog/terra-crust/actions/workflows/golang-build-test-coverage.yml/badge.svg?branch=main) [![Go Report Card](https://goreportcard.com/badge/github.com/AppsFlyer/terra-crust)](https://goreportcard.com/report/github.com/AppsFlyer/terra-crust) [![codecov](https://codecov.io/gh/AppsFlyer/terra-crust/branch/main/graph/badge.svg)](https://codecov.io/gh/AppsFlyer/terra-crust)
+
 <img src="./docs/images/logo/terra-crust.png" width="400">
 
 ----
@@ -25,13 +27,13 @@ At the end of the flow it will run Terraform FMT to format the files.
 ## Output Examples:
 
 ### Variables:
-![](/img/vars.jpg)
+![](/docs/images/vars.jpg)
 
 ### Locals:
-![](/img/locals.jpg)
+![](/docs/images/locals.jpg)
 
 ### Main:
-![](/img/main.jpg)
+![](/docs/images/main.jpg)
 
 ## Commands:
 ### Create Main: