Remove docker-compose in favor of docker (#10)

pellared · web-flow · commit d26693a6cf75 · 2020-05-28T22:15:46.000+02:00
* Remove docker-compose in favor of docker

* Enhance make targets

* Remove modd
diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json
@@ -2,8 +2,7 @@
 // https://github.com/microsoft/vscode-dev-containers
 {
 	"name": "Go",
-	"context": "..",
-	"dockerFile": "../Dockerfile",
+	"image": "golang:1.14",
 	"runArgs": [
 		"--cap-add=SYS_PTRACE",
 		"--security-opt",
@@ -21,7 +20,7 @@
 	// Use 'forwardPorts' to make a list of ports inside the container available locally.
 	// "forwardPorts": [],
 	// Use 'postCreateCommand' to run commands after the container is created.
-	"postCreateCommand": "apt-get update && apt-get install -y git"
+	"postCreateCommand": "apt-get update && apt-get install -y git && make install"
 	// Uncomment to connect as a non-root user. See https://aka.ms/vscode-remote/containers/non-root.
 	// "remoteUser": "vscode"
-}
+}
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -1,9 +1,9 @@
 name: build
 on: push
 jobs:
-  docker-compose:
+  ci-build:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
       - name: Build
-        run: docker-compose up --abort-on-container-exit
+        run: make docker run="make all"
diff --git a/.vscode/extensions.json b/.vscode/extensions.json
@@ -2,4 +2,4 @@
     "recommendations": [
         "ms-vscode.go"
     ]
-}
+}
diff --git a/.vscode/launch.json b/.vscode/launch.json
@@ -14,4 +14,4 @@
             "args": []
         }
     ]
-}
+}
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -6,4 +6,4 @@
     "go.lintFlags": [
         "--fast"
     ]
-}
+}
diff --git a/.vscode/tasks.json b/.vscode/tasks.json
@@ -4,40 +4,16 @@
     "version": "2.0.0",
     "tasks": [
         {
-            "label": "all",
+            "label": "dev",
             "type": "shell",
-            "command": "make all",
+            "command": "make dev",
             "problemMatcher": [
                 "$go"
             ],
-            "group": "build"
-        },
-        {
-            "label": "build",
-            "type": "shell",
-            "command": "make build",
-            "problemMatcher": [
-                "$go"
-            ],
-            "group": "build"
-        },
-        {
-            "label": "lint",
-            "type": "shell",
-            "command": "make lint",
-            "problemMatcher": [
-                "$go"
-            ],
-            "group": "build"
-        },
-        {
-            "label": "test",
-            "type": "shell",
-            "command": "make test",
-            "problemMatcher": [
-                "$go"
-            ],
-            "group": "build"
+            "group": {
+                "kind": "build",
+                "isDefault": true
+            }
         }
     ]
-}
+}
diff --git a/Dockerfile b/Dockerfile
diff --git a/Makefile b/Makefile
@@ -1,28 +1,56 @@
 .DEFAULT_GOAL := help
 
 .PHONY: all
-all: ## full build: build, lint, test
-all: build lint test
+all: ## full build
+all: clean install build fmt lint test
+
+.PHONY: dev
+dev: ## fast build
+dev: install build fmt lint-fast test
+
+.PHONY: clean
+clean: ## go clean
+	$(call print-target)
+	go clean -r -i -cache -testcache -modcache
+
+.PHONY: install
+install: ## install build tools
+	$(call print-target)
+	./install.sh
 
 .PHONY: build
 build: ## go build
 	$(call print-target)
 	go build ./...
 
+.PHONY: fmt
+fmt: ## goimports
+	$(call print-target)
+	goimports -l -w .
+
 .PHONY: lint
 lint: ## golangci-lint
 	$(call print-target)
 	golangci-lint run
 
+.PHONY: lint-fast
+lint-fast: ## golangci-lint --fast
+	$(call print-target)
+	golangci-lint run --fast
+
 .PHONY: test
 test: ## go test with race detector and code covarage
 	$(call print-target)
 	go test -race -covermode=atomic
 
+.PHONY: docker
+docker: ## run in golang container, example: make docker run="make all"
+	docker run --rm -v $(CURDIR):/app golang:1.14 sh -c "cd /app && $(run)"
+
 .PHONY: help
 help:
 	@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}'
 
 define print-target
-    @echo "Executing target: \033[36m$@\033[0m"
+    @printf "Executing target: \033[36m$@\033[0m\n"
 endef
diff --git a/README.md b/README.md
@@ -13,10 +13,9 @@ This is a GitHub repository template for Go. It has been created for ease-of-use
 It includes:
 
 - [Visual Studio Code](https://code.visualstudio.com) configuration with [Go](https://code.visualstudio.com/docs/languages/go) and [Remote Container](https://code.visualstudio.com/docs/remote/containers) support,
-- [modd](https://github.com/cortesi/modd) configuration,
 - dependency management using [Go Modules](https://github.com/golang/go/wiki/Modules),
 - linting with [GolangCI-Lint](https://github.com/golangci/golangci-lint),
-- build automation via [Make](https://www.gnu.org/software/make), [Docker](https://docs.docker.com/engine), [Docker Compose](https://docs.docker.com/compose), [GitHub Actions](https://github.com/features/actions).
+- build automation via [Make](https://www.gnu.org/software/make), [Docker](https://docs.docker.com/engine), [GitHub Actions](https://github.com/features/actions).
 
 `Star` this repository if you find it valuable and worth maintaining.
 
@@ -32,47 +31,42 @@ It includes:
 
 1. Install [Go](https://golang.org/doc/install) and [Go extension](https://code.visualstudio.com/docs/languages/go).
 1. Visual Studio Code: `View` → `Command Pallete... (F1)` → Select `Go: Install/Update Tools`.
-1. See [Dockerfile](Dockerfile) for GolangCI-Lint installation command.
 
 **Make on Windows:** Use [WSL (Windows Subsystem for Linux)](https://docs.microsoft.com/en-us/windows/wsl/install-win10) or try [Make Windows port](https://gist.github.com/evanwill/0207876c3243bbb6863e65ec5dc3f058).
 
 #### Visual Studio Code - Development Container
 
 1. [Setup Development inside a Container](https://code.visualstudio.com/docs/remote/containers#_getting-started).
 1. Visual Studio Code inside Container: `View` → `Command Pallete... (F1)` → Select `Go: Install/Update Tools`.
-1. See [Dockerfile](Dockerfile) for GolangCI-Lint installation command.
 
 #### Visual Studio Code - SSH
 
 1. [Setup Remote Development using SSH](https://code.visualstudio.com/docs/remote/ssh#_getting-started).
 1. On remote machine: install [Go](https://golang.org/doc/install) and [Go extension](https://code.visualstudio.com/docs/languages/go).
 1. Visual Studio Code: `View` → `Command Pallete... (F1)` → Select `Go: Install/Update Tools`.
-1. See [Dockerfile](Dockerfile) for GolangCI-Lint installation command.
 
 ### Build
 
-- Terminal: `make all`.
-- Visual Studio Code: `Terminal` → `Run Build Task... (CTRL+ALT+B)` → Select `All`.
-- Terminal: `docker-compose up --abort-on-container-exit`. This command is executed by CI build (GitHub Action workflow).
-- [modd](https://github.com/cortesi/modd) would execute build on any *.go file change.
+- Terminal: `make` to get help for make target.
+- Terminal: `make all` to execute a full build.
+- Visual Studio Code: `Terminal` → `Run Build Task... (CTRL+ALT+B)` to execute a fast build.
 
 ### Maintainance
 
 1. `Watch` this repository to get notified about new releases, issues, etc.
-1. Update Go and GolangCI-Lint version in [Dockerfile](Dockerfile).
+1. Update Go version in [Makefile](Makefile) and [devcontainer.json](.devcontainer/devcontainer.json).
+1. Update and add additional build tools in [install.sh](install.sh).
 1. Configure linters via [.golangci.yml](.golangci.yml).
-1. Develop Make targets in [Makefile](Makefile) and assosiated tasks in [.vscode/tasks.json](.vscode/tasks.json).
+1. Develop Make targets in [Makefile](Makefile).
 
 Notable files:
 
 - [devcontainer.json](.devcontainer/devcontainer.json) - Visual Studio Code Remote Container configuration
 - [.github](.github/workflows/build.yml) - GitHub Action workflow (CI build)
 - [.vscode](.vscode) - Visual Studio Code configuration files
 - [.golangci.yml](.golangci.yml) - GolangCI-Lint configuration
-- [docker-compose.yml](docker-compose.yml) - Compose file used in [CI build](.github/workflows/build.yml)
-- [Dockerfile](Dockerfile) - Builder image used in [docker-compose.yml](docker-compose.yml) and [devcontainer.json](.devcontainer/devcontainer.json)
-- [Makefile](Makefile) - Make targets used in [docker-compose.yml](docker-compose.yml) and [.vscode/tasks.json](.vscode/tasks.json)
-- [modd.conf](modd.conf) - [modd](https://github.com/cortesi/modd) configuration file
+- [install.sh](install.sh) - build tools installation script
+- [Makefile](Makefile) - Make targets used in [CI build](.github/workflows/build.yml) and [.vscode/tasks.json](.vscode/tasks.json)
 
 ## FAQ
 
@@ -83,7 +77,7 @@ The maintainer does not use GoLand. Fell free to create a pull request for [#2](
 ### Why GitHub Actions, not any other CI server
 
 GitHub Actions is out-of-the-box if you are already using GitHub.
-However, changing to any other CI server should be very simple, because this repository uses Docker Compose to run CI build to make the transition easy.
+However, changing to any other CI server should be very simple, because this repository uses Docker to run CI build to make the transition easy.
 
 For [CircleCI](https://circleci.com/docs/2.0/executor-types/#using-machine) create `.circleci/config.yml` file:
 
@@ -95,7 +89,7 @@ jobs:
       image: ubuntu-1604:201903-01
     steps:
       - checkout
-      - run: docker-compose up --abort-on-container-exit
+      - run: make docker run="make all"
 ```
 
 ## Contributing
diff --git a/docker-compose.yml b/docker-compose.yml
diff --git a/install.sh b/install.sh
@@ -0,0 +1,9 @@
+#!/usr/bin/env bash
+set -euo pipefail
+
+cd && GO111MODULE=on go get golang.org/x/tools/cmd/goimports@master && cd - > /dev/null
+
+if ! [ -x "$(command -v golangci-lint)" ] || [ "$(golangci-lint --version)" != "golangci-lint has version 1.27.0 built from fb74c2e on 2020-05-13T18:48:26Z" ] ; then
+    echo Installing golangci-lint...
+    curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b $(go env GOPATH)/bin v1.27.0
+fi
diff --git a/modd.conf b/modd.conf

Original file line number	Diff line number	Diff line change
`@@ -2,4 +2,4 @@`
`2`	`2`	`"recommendations": [`
`3`	`3`	`"ms-vscode.go"`
`4`	`4`	`]`
`5`		`-}`
	`5`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -14,4 +14,4 @@`
`14`	`14`	`"args": []`
`15`	`15`	`}`
`16`	`16`	`]`
`17`		`-}`
	`17`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -6,4 +6,4 @@`
`6`	`6`	`"go.lintFlags": [`
`7`	`7`	`"--fast"`
`8`	`8`	`]`
`9`		`-}`
	`9`	`+}`