[pull] master from moshebe:master

.github/workflows/lint-test.yml

@@ -0,0 +1,58 @@
+name: lint-test
+on:
+  push:
+    tags:
+      - v*
+    branches:
+      - "*"
+    paths-ignore:
+      - '**/README.md'
+      - '**/webui'
+  pull_request:
+permissions:
+  contents: read
+jobs:
+  golangci:
+    name: Lint
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-go@v3
+        with:
+          go-version: '^1.18'
+      - name: golangci-lint
+        uses: golangci/golangci-lint-action@v3
+        with:
+          version: v1.55.2
+  test:
+    name: Test
+    runs-on: ubuntu-latest
+    steps:
+      - name: Install Go
+        uses: actions/setup-go@v3
+        with:
+          go-version: '1.21.6'
+      - name: Checkout code
+        uses: actions/checkout@v3
+      - uses: actions/cache@v2
+        with:
+          # In order:
+          # * Module download cache
+          # * Build cache (Linux)
+          # * Build cache (Mac)
+          # * Build cache (Windows)
+          path: |
+            ~/go/pkg/mod
+            ~/.cache/go-build
+            ~/Library/Caches/go-build
+            %LocalAppData%\go-build
+          key: ${{ runner.os }}-go-${{ hashFiles('**/go.sum') }}
+          restore-keys: |
+            ${{ runner.os }}-go-
+      - name: Test
+        run: go test -cover ./...
+      - name: Coverage
+        if: github.repository_owner == 'moshebe'
+        run: |
+          make coverage
+          bash <(curl -s https://codecov.io/bash)

.github/workflows/release.yml

@@ -0,0 +1,23 @@
+name: release
+on:
+  push:
+    tags:
+      - "*"
+jobs:
+  releaser:
+    name: go-releaser
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0 # See: https://goreleaser.com/ci/actions/
+      - run: git fetch --force --tags
+      - uses: actions/setup-go@v4
+        with:
+          go-version: stable
+      - uses: goreleaser/goreleaser-action@v4
+        with:
+          version: latest
+          args: release --clean
+        env:
+          GITHUB_TOKEN: ${{ secrets.GO_RELEASER_TOKEN }}

.gitignore

@@ -18,3 +18,4 @@
 gebug
 .gebug
 coverage.txt
+dist

.goreleaser.yaml

@@ -0,0 +1,38 @@
+before:
+  hooks:
+    - go mod tidy
+    - go generate ./...
+builds:
+  - env:
+      - CGO_ENABLED=0
+    ldflags:
+      - -X github.com/moshebe/gebug/version.Version={{.Version}}
+    goos:
+      - linux
+      - windows
+      - darwin
+    goarch:
+      - amd64
+      - arm64
+archives:
+  - replacements:
+      darwin: Darwin
+      linux: Linux
+      windows: Windows
+      amd64: x86_64
+checksum:
+  name_template: 'checksums.txt'
+snapshot:
+  name_template: "{{ incpatch .Version }}-next"
+changelog:
+  sort: asc
+  filters:
+    exclude:
+      - '^docs:'
+      - '^test:'
+brews:
+  - name: gebug
+    homepage: https://github.com/moshebe/gebug
+    tap:
+      owner: moshebe
+      name: homebrew-pkg

Makefile

@@ -1,10 +1,22 @@
+# Makefile params
+SHELL             = /bin/bash -o pipefail
+
 WORKROOT := $(shell pwd)
 OUTDIR   := $(WORKROOT)/output
 
-export PATH        := $(shell go env GOPATH)/bin:$(PATH)
-export GO111MODULE := on
+GOARCH            = amd64
+GOOS              ?= $(shell go env GOOS)
+GOPATH            ?= $(shell go env GOPATH)
+COMMIT            ?= $(shell git rev-parse HEAD)
+BRANCH            ?= $(shell git rev-parse --abbrev-ref HEAD)
+BUILD_DATE        ?= $(shell date -u +"%Y-%m-%d")
+VERSION           ?= $(shell git describe --long --tags)
+BASENAME          ?= gebug
+BINARY            ?= ${BASENAME}
+VERSION_PKG   	  = github.com/moshebe/gebug/version
+LDFLAGS	          = -ldflags \
+					"-X ${VERSION_PKG}.Version=${VERSION} -X ${VERSION_PKG}.Revision=${COMMIT} -X ${VERSION_PKG}.Branch=${BRANCH}"
 
-GOFLAGS      := -race
 STATICCHECK  := staticcheck
 
 ARCH := $(shell getconf LONG_BIT)
@@ -21,7 +33,12 @@ all: compile package
 
 compile: test build
 build:
-	go build -ldflags "-X main.version=$(GEBUG_VERSION) -X main.commit=$(GIT_COMMIT)"
+	go build ${LDFLAGS}
+
+.PHONY: buildall
+	$(MAKE) build GOOS=windows BINARY=${BINARY}-windows-${GOARCH}.exe
+	$(MAKE) build GOOS=linux BINARY=${BINARY}-linux-${GOARCH}
+	$(MAKE) build GOOS=darwin BINARY=${BINARY}-darwin-${GOARCH}
 
 test: test-case vet-case
 test-case:
@@ -33,6 +50,11 @@ coverage:
 	echo -n > coverage.txt
 	for pkg in $(PKGS) ; do go test -coverprofile=profile.out -covermode=atomic $${pkg} && cat profile.out >> coverage.txt; done
 
+package:
+	mkdir -p $(OUTDIR)/bin
+	mv bfe  $(OUTDIR)/bin
+	cp -r conf $(OUTDIR)
+
 check:
 	go install honnef.co/go/tools/cmd/staticcheck@latest
 	staticcheck ./...
@@ -43,4 +65,4 @@ clean:
 	rm -rf $(WORKROOT)/.gebug
 	rm -rf $(GOPATH)/pkg/linux_amd64
 
-.PHONY: all compile test package clean build
+.PHONY: all compile test package clean build buildall

README.md

@@ -10,9 +10,15 @@ A tool that makes debugging of Dockerized Go applications super easy by enabling
 [![Go Report Card](https://goreportcard.com/badge/github.com/moshebe/gebug)](https://goreportcard.com/report/github.com/moshebe/gebug)
 [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
 ---
-# Installing
+# Installation
+### [Homebrew](https://brew.sh/) (Linux/macOS)
+```shell
+brew install gebug
 ```
-go get -u github.com/moshebe/gebug
+### [Go](https://golang.org) (Linux/Windows/macOS/any other platform supported by Go)
+If you have Go 1.16+, you can install latest released version of `gebug` directly from source by running:
+```shell
+go install github.com/moshebe/gebug@latest
 ```
 
 # Usage
@@ -69,7 +75,7 @@ Let's examine the `config.yaml` fields so you will feel more comfortable editing
 | output_binary    	| /app                           	    | output binary artifact inside the runtime container                                                                                                                                                                                     	|
 | build_command    	| go build -o {{.output_binary}}  	    | build command inside the runtime container.  Note you can reference other configuration fields. When enabling Debugger `-gcflags="all=-N -l"` will be appended  to the build command to stop compiler optimization and symbol removing 	|
 | run_command      	| {.output_binary}}              	    | run command, probably most of the time will just be the binary artifact path                                                                                                                                                            	|
-| runtime_image    	| golang:1.17                    	    | base Docker image for the runtime container                                                                                                                                                                                             	|
+| runtime_image    	| golang:1.20                    	    | base Docker image for the runtime container                                                                                                                                                                                             	|
 | debugger_enabled 	| false                            	    | whether to enable delve debugger inside the container or just use hot-reload                                                                                                                                                            	|
 | debugger_port    	| 40000                            	    | delve debugger listen port, relevant only if `debugger_enabled` was set                                                                                                                                                                 	|
 | expose_ports     	| []                               	    | list of ports to expose inside the container. Uses the same syntax as docker-compose for mapping between host and container ports(e.g: "8080:8080"). No need to add the delve debugger listen port as it will be auto-added            	|

cmd/completion.go

@@ -1,11 +1,11 @@
 /*
-Copyright © 2021 NAME HERE <EMAIL ADDRESS>
+Copyright © 2021 Gebug
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.
 You may obtain a copy of the License at
 
-    http://www.apache.org/licenses/LICENSE-2.0
+	http://www.apache.org/licenses/LICENSE-2.0
 
 Unless required by applicable law or agreed to in writing, software
 distributed under the License is distributed on an "AS IS" BASIS,
@@ -67,7 +67,7 @@ PS> gebug completion powershell > gebug.ps1
 `,
 	DisableFlagsInUseLine: true,
 	ValidArgs:             []string{"bash", "zsh", "fish", "powershell"},
-	Args:                  cobra.ExactValidArgs(1),
+	Args:                  cobra.MatchAll(cobra.ExactArgs(1), cobra.OnlyValidArgs),
 	Run: func(cmd *cobra.Command, args []string) {
 		var err error
 		switch args[0] {

cmd/ui.go

@@ -2,7 +2,6 @@ package cmd
 
 import (
 	"fmt"
-	"io/ioutil"
 	"os"
 	"sync"
 
@@ -44,7 +43,7 @@ var uiCmd = &cobra.Command{
 			projectPath = cwd
 		}
 
-		file, err := ioutil.TempFile("", "gebug-webui-docker-compose.*.yml")
+		file, err := os.CreateTemp("", "gebug-webui-docker-compose.*.yml")
 		if err != nil {
 			zap.L().Fatal("Failed to create temporary file for generating docker-compose", zap.Error(err))
 		}

cmd/version.go

@@ -3,6 +3,7 @@ package cmd
 import (
 	"fmt"
 
+	"github.com/moshebe/gebug/version"
 	"github.com/spf13/cobra"
 )
 
@@ -12,9 +13,9 @@ func init() {
 
 var versionCmd = &cobra.Command{
 	Use:   "version",
-	Short: "Gebug's version",
+	Short: "Gebug version",
 	Long:  "Print the version number of Gebug",
 	Run: func(cmd *cobra.Command, args []string) {
-		fmt.Println("v0.0.1")
+		fmt.Println(version.Name())
 	},
 }

doc.go

@@ -22,7 +22,7 @@ Configurations
 	output_binary		- output binary artifact inside the runtime container (default: "/app")
 	build_command		- build command inside the runtime container (default: "go build -o {{.output_binary}}")
 	run_command		- run command, probably most of the time will just be the binary artifact path (default: "{.output_binary}}")
-	runtime_image 		- base Docker image for the runtime container (default: "golang:1.17")
+	runtime_image 		- base Docker image for the runtime container (default: "golang:1.20")
 	debugger_enabled 	- whether to enable delve debugger inside the container or just use hot-reload (default: false)
 	debugger_port 		- delve debugger listen port, relevant only if debugger_enabled was set (default: 40000)
 	expose_ports 		- list of ports to expose inside the container (default: [])