Initial commit

Author: mccutchen

.github/workflows/lint.yaml

@@ -0,0 +1,19 @@
+name: lint
+
+on:
+  push:
+    branches: [main] # on pushes TO main
+  pull_request:
+    branches: [main] # on pull requests AGAINST main
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-go@v5
+        with:
+          go-version: 'stable'
+      - uses: golangci/golangci-lint-action@v6
+        with:
+          version: latest

.github/workflows/test.yaml

@@ -0,0 +1,43 @@
+name: test
+
+on:
+  push:
+    branches: [main] # on pushes TO main
+  pull_request:
+    branches: [main] # on pull requests AGAINST main
+
+# cancel CI runs when a new commit is pushed to any branch except main
+concurrency:
+  group: "test-${{ github.ref }}"
+  cancel-in-progress: ${{ github.ref != 'refs/heads/main' }}
+
+jobs:
+  test:
+    name: test
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        # build against the two latest releases, to match golang's release
+        # policy: https://go.dev/doc/devel/release#policy
+        go-version:
+        - 'stable'
+        - 'oldstable'
+
+    steps:
+    - name: setup
+      uses: actions/setup-go@v5
+      with:
+        go-version: ${{matrix.go-version}}
+
+    - name: checkout
+      uses: actions/checkout@v4
+
+    - name: test
+      run: make testci
+
+    - name: report code coverage
+      uses: codecov/codecov-action@v5
+      with:
+        files: ./coverage.out
+      if: ${{ matrix.go-version == 'stable' }}

.gitignore

@@ -0,0 +1,12 @@
+# Binaries for programs and plugins
+*.exe
+*.exe~
+*.dll
+*.so
+*.dylib
+
+# Test binary, build with `go test -c`
+*.test
+
+# Output of the go coverage tool, specifically when used with LiteIDE
+*.out

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Will McCutchen
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

Makefile

@@ -0,0 +1,34 @@
+# Default flags used by the test, testci, testcover targets
+COVERAGE_PATH ?= coverage.out
+COVERAGE_ARGS ?= -covermode=atomic -coverprofile=$(COVERAGE_PATH)
+TEST_ARGS     ?= -race $(COVERAGE_ARGS)
+
+# 3rd party tools
+LINT        := go run github.com/mgechev/revive@v1.5.1
+STATICCHECK := go run honnef.co/go/tools/cmd/staticcheck@2024.1.1
+
+test:
+	go test $(TEST_ARGS) ./...
+.PHONY: test
+
+# Test command to run for continuous integration, which includes code coverage
+# based on codecov.io's documentation:
+# https://github.com/codecov/example-go/blob/b85638743b972bd0bd2af63421fe513c6f968930/README.md
+testci:
+	go test $(TEST_ARGS) $(COVERAGE_ARGS) ./...
+.PHONY: testci
+
+testcover: testci
+	go tool cover -html=$(COVERAGE_PATH)
+.PHONY: testcover
+
+lint:
+	test -z "$$(gofmt -d -s -e .)" || (echo "Error: gofmt failed"; gofmt -d -s -e . ; exit 1)
+	go vet ./...
+	$(LINT) -set_exit_status ./...
+	$(STATICCHECK) ./...
+.PHONY: lint
+
+clean:
+	rm -rf $(COVERAGE_PATH)
+.PHONY: clean

README.md

@@ -0,0 +1,31 @@
+# go-pkg-template
+
+[![Documentation](https://pkg.go.dev/badge/github.com/mccutchen/go-pkg-template)](https://pkg.go.dev/github.com/mccutchen/go-pkg-template)
+[![Build status](https://github.com/mccutchen/go-pkg-template/actions/workflows/test.yaml/badge.svg)](https://github.com/mccutchen/go-pkg-template/actions/workflows/test.yaml)
+[![Code coverage](https://codecov.io/gh/mccutchen/go-pkg-template/branch/main/graph/badge.svg)](https://codecov.io/gh/mccutchen/go-pkg-template)
+[![Go report card](http://goreportcard.com/badge/github.com/mccutchen/go-pkg-template)](https://goreportcard.com/report/github.com/mccutchen/go-pkg-template)
+
+Template repo for Go packages/libraries
+
+TODO:
+- Replace go-pkg-template with new repo name
+- Add high level description
+- Add usage examples
+- Set up branch protection rules
+  - Require linear history
+  - Require pull requests
+  - Require lint/test CI checks to pass
+- Set up security scanning
+- Maybe:
+  - Update go version in go.mod
+  - Update action versions in .github/workflows/*.yaml
+
+## Usage
+
+TK
+
+## Testing
+
+```bash
+make test
+```

go.mod

@@ -0,0 +1,3 @@
+module github.com/mccutchen/go-pkg-template
+
+go 1.23.0