feat: ⚡ add magefile setup

add magefile setup

Author: yuanyu90221

.github/workflows/go.yml

@@ -25,4 +25,8 @@ jobs:
       - name: Task Build
         run: task build
       - name: Task Test
-        run: task test
+        run: task test
+      - name: Task Build for mage
+        run: task build-gg
+      - name: Test with gg
+        run: gg test

.gitignore

@@ -23,4 +23,6 @@ go.work.sum
 
 # env file
 .env
-bin
+bin
+gg
+mage

README.md

@@ -266,4 +266,92 @@ func Test_DeleteNewsByID(t *testing.T) {
 		})
 	}
 }
-```
+```
+
+## Add Mage Tools
+
+[Mage](https://magefile.org/) is a tool for setup build tool with golang
+
+### how to use
+
+1. install dependency
+
+```shell
+go get github.com/magefile/mage/mage
+```
+
+2. create a execute file
+
+```golang
+//go:build ignore
+// +build ignore
+
+package main
+
+import (
+	"os"
+
+	"github.com/magefile/mage/mage"
+)
+
+func main() { os.Exit(mage.Main()) }
+```
+
+**Notice**: 檔案前面的 // +build ignore 是避免 mage 編譯這隻檔案
+
+3. create a task file for run task
+
+```golang
+//go:build mage
+// +build mage
+
+package main
+
+import (
+	"github.com/magefile/mage/mg"
+	"github.com/magefile/mage/sh"
+)
+
+var Default = Build
+
+// clean the build binary
+func Clean() error {
+	return sh.Rm("bin")
+}
+
+// Creates the binary in the current directory.
+func Build() error {
+	mg.Deps(Clean)
+	if err := sh.Run("go", "mod", "download"); err != nil {
+		return err
+	}
+	return sh.Run("go", "build", "-o", "./bin/server", "./cmd/main.go")
+}
+
+// start the server
+func Launch() error {
+	mg.Deps(Build)
+	err := sh.RunV("./bin/server")
+	if err != nil {
+		return err
+	}
+	return nil
+}
+
+// run the test
+func Test() error {
+	err := sh.RunV("go", "test", "-v", "./...")
+	if err != nil {
+		return err
+	}
+	return nil
+}
+```
+
+task 形式分成兩種 1. 有 error return 值 2. 沒有 error return 
+
+而參數的部份可以帶入 context 來作而外的處理
+
+相依性則透過 mg.Deps 來設定
+
+預設不會列印執行結果及過程。如果需要有列印執行結果，需要使用 sh.RunV 來作處理

Taskfile.yaml

@@ -16,6 +16,16 @@ tasks:
     deps:
       - build
     silent: true
+  build-mage:
+    cmds:
+      - CGO_ENABLED=0 GOOS=linux go build -o mage mage-tools/mage.go
+    silent: true
+  build-gg:
+    cmds:
+      - mage -d mage-tools -compile ../gg
+    deps:
+      - build-mage
+    silent: true
   coverage:
     cmds:
       - go test -v -cover ./...

go.mod

@@ -23,6 +23,7 @@ require (
 	github.com/json-iterator/go v1.1.12 // indirect
 	github.com/klauspost/cpuid/v2 v2.2.8 // indirect
 	github.com/leodido/go-urn v1.4.0 // indirect
+	github.com/magefile/mage v1.15.0 // indirect
 	github.com/mattn/go-isatty v0.0.20 // indirect
 	github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd // indirect
 	github.com/modern-go/reflect2 v1.0.2 // indirect

go.sum

@@ -49,6 +49,8 @@ github.com/kr/text v0.2.0 h1:5Nx0Ya0ZqY2ygV366QzturHI13Jq95ApcVaJBhpS+AY=
 github.com/kr/text v0.2.0/go.mod h1:eLer722TekiGuMkidMxC/pM04lWEeraHUUmBw8l2grE=
 github.com/leodido/go-urn v1.4.0 h1:WT9HwE9SGECu3lg4d/dIA+jxlljEa1/ffXKmRjqdmIQ=
 github.com/leodido/go-urn v1.4.0/go.mod h1:bvxc+MVxLKB4z00jd1z+Dvzr47oO32F/QSNjSBOlFxI=
+github.com/magefile/mage v1.15.0 h1:BvGheCMAsG3bWUDbZ8AyXXpCNwU9u5CB6sM+HNb9HYg=
+github.com/magefile/mage v1.15.0/go.mod h1:z5UZb/iS3GoOSn0JgWuiw7dxlurVYTu+/jHXqQg881A=
 github.com/magiconair/properties v1.8.7 h1:IeQXZAiQcpL9mgcAe1Nu6cX9LLw6ExEHKjN0VQdvPDY=
 github.com/magiconair/properties v1.8.7/go.mod h1:Dhd985XPs7jluiymwWYZ0G4Z61jb3vdS329zhj2hYo0=
 github.com/mattn/go-isatty v0.0.20 h1:xfD0iDuEKnDkl03q4limB+vH+GxLEtL/jb4xVJSWWEY=

mage-tools/mage.go

@@ -0,0 +1,12 @@
+//go:build ignore
+// +build ignore
+
+package main
+
+import (
+	"os"
+
+	"github.com/magefile/mage/mage"
+)
+
+func main() { os.Exit(mage.Main()) }

mage-tools/magefile.go

@@ -0,0 +1,44 @@
+//go:build mage
+// +build mage
+
+package main
+
+import (
+	"github.com/magefile/mage/mg"
+	"github.com/magefile/mage/sh"
+)
+
+var Default = Build
+
+// clean the build binary
+func Clean() error {
+	return sh.Rm("bin")
+}
+
+// Creates the binary in the current directory.
+func Build() error {
+	mg.Deps(Clean)
+	if err := sh.Run("go", "mod", "download"); err != nil {
+		return err
+	}
+	return sh.Run("go", "build", "-o", "./bin/server", "./cmd/main.go")
+}
+
+// start the server
+func Launch() error {
+	mg.Deps(Build)
+	err := sh.RunV("./bin/server")
+	if err != nil {
+		return err
+	}
+	return nil
+}
+
+// run the test
+func Test() error {
+	err := sh.RunV("go", "test", "-v", "./...")
+	if err != nil {
+		return err
+	}
+	return nil
+}