Merge pull request #40 from btnguyen2k/release

Merge to main after releasing new version 0.2.0

Author: btnguyen2k

.github/workflows/ci.yaml

@@ -9,6 +9,39 @@ on:
   workflow_call:
 
 jobs:
+  GoFmt:
+    runs-on: ubuntu-latest
+    name: Check format with go fmt
+    steps:
+      - name: Check out code
+        uses: actions/checkout@v4
+      - name: Set up Go env
+        uses: actions/setup-go@v4
+        with:
+          # pick one Go version to check format
+          go-version: '1.18'
+      - name: Run go fmt
+        run: |
+          go version
+          go fmt ./...
+
+  GoLint:
+    name: GoLint
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out code
+        uses: actions/checkout@v4
+      - name: Set up Go env
+        uses: actions/setup-go@v4
+        with:
+          # pick one Go version for linting
+          go-version: '1.18'
+      - name: golangci-lint
+        uses: golangci/golangci-lint-action@v3
+        with:
+          version: latest
+          only-new-issues: true
+
   Test:
     runs-on: ubuntu-latest
     strategy:
@@ -25,7 +58,13 @@ jobs:
       - name: Run tests
         run: |
           go version
-          go test -v -timeout 9999s -count 1 -p 1 -cover -coverprofile coverage.txt .
+          go test -v -timeout 9999s -count 1 -p 1 -cover -coverprofile coverage.txt ./
+      - name: Run tests (in different package)
+        run: |
+          go version
+          cd module_test && \
+            go test -v -timeout 9999s -count 1 -p 1 -cover -coverprofile ../coverage_test_package.txt -coverpkg=github.com/btnguyen2k/mymodule ./ && \
+            cd ..
       - name: Codecov
         uses: codecov/codecov-action@v3
         with:

RELEASE-NOTES.md

@@ -1,5 +1,13 @@
 # go-module-template release notes
 
+## 2023-12-08 - v0.2.0
+
+### Added/Refactoring
+
+- Add feature: golangci-lint
+- Add format check to CI pipeline
+- Add feature: tests in a seperate package
+
 ## 2023-11-26 - v0.1.1
 
 ### Fixed/Improvement

module.go

@@ -3,7 +3,7 @@ package mymodule
 
 const (
 	// Version holds the semantic version number of this module.
-	Version = "0.1.1"
+	Version = "0.2.0"
 )
 
 // This file contains module's metadata only, which is package level documentation and module Version string.

module_test/code_test.go

@@ -0,0 +1,45 @@
+package module_test
+
+import (
+	"github.com/btnguyen2k/mymodule"
+	"reflect"
+	"testing"
+)
+
+// sample tests
+
+func TestClone_int(t *testing.T) {
+	testName := "TestClone_int"
+	input := []int{1, 2, 3}
+	output := mymodule.Clone(input)
+	if !reflect.DeepEqual(input, output) {
+		t.Fatalf("%s failed: expected %v but received %v", testName, input, output)
+	}
+}
+
+func TestClone_uint(t *testing.T) {
+	testName := "TestClone_uint"
+	input := []uint{4, 5, 6}
+	output := mymodule.Clone(input)
+	if !reflect.DeepEqual(input, output) {
+		t.Fatalf("%s failed: expected %v but received %v", testName, input, output)
+	}
+}
+
+func TestClone_float(t *testing.T) {
+	testName := "TestClone_float"
+	input := []float64{7.8, 8.9, 9.0}
+	output := mymodule.Clone(input)
+	if !reflect.DeepEqual(input, output) {
+		t.Fatalf("%s failed: expected %v but received %v", testName, input, output)
+	}
+}
+
+func TestClone_string(t *testing.T) {
+	testName := "TestClone_string"
+	input := []string{"string 1", "string 2", "string 3"}
+	output := mymodule.Clone(input)
+	if !reflect.DeepEqual(input, output) {
+		t.Fatalf("%s failed: expected %v but received %v", testName, input, output)
+	}
+}

module_test/go.mod

@@ -0,0 +1,7 @@
+module module_test
+
+go 1.18
+
+require github.com/btnguyen2k/mymodule v0.0.0-00010101000000-000000000000
+
+replace github.com/btnguyen2k/mymodule => ../

module_test/go.sum

@@ -0,0 +1 @@
+github.com/btnguyen2k/consu/semver v0.2.1 h1:le0FzrM7u0IOR4MnOyBySHpZ/p3vV4JjofAhPB7edWE=