Initial commit

.githooks/commit-msg

@@ -0,0 +1,4 @@
+#!/bin/bash
+
+echo "running commitlint against git history"
+npx -p @commitlint/config-conventional -p @commitlint/cli -c "cat $1 | commitlint"

.githooks/pre-commit

@@ -0,0 +1,13 @@
+#!/bin/bash
+
+echo "running yamllint against repository"
+yamllint .
+
+echo "running go test ./..."
+# a bit of bash trickery to silence the output on success
+output="$(go test ./...)"
+
+if [[ $? -ne 0 ]] ; then
+    echo "$output"
+fi
+

.github/workflows/pull_request.yml

@@ -0,0 +1,66 @@
+---
+on: [pull_request]  # yamllint disable-line rule:truthy
+name: main
+jobs:
+
+  commitlint:
+    runs-on: ubuntu-latest
+    steps:
+
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+
+      - uses: actions/setup-node@v3
+        with:
+          node-version: lts/*
+      - run: npm install --save-dev @commitlint/{config-conventional,cli}
+      - run: npx commitlint --from=${{ github.event.pull_request.base.sha }}
+
+  golangci-lint:
+    strategy:
+      matrix:
+        go-version: [1.20.x]
+        os: [ubuntu-latest, macos-latest]
+    name: lint
+    runs-on: ${{ matrix.os }}
+    steps:
+
+      - uses: actions/checkout@v3
+
+      - name: golangci-lint
+        uses: golangci/golangci-lint-action@v2
+        with:
+          version: v1.51.1
+
+  yamllint:
+    runs-on: ubuntu-latest
+    steps:
+
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+
+      - name: yaml-lint
+        uses: ibiqlik/action-yamllint@v3
+
+  test:
+    strategy:
+      matrix:
+        go-version: [1.20.x]
+        os: [ubuntu-latest, macos-latest]
+    runs-on: ${{ matrix.os }}
+    steps:
+
+      - name: Install Go
+        uses: actions/setup-go@v2
+        with:
+          go-version: ${{ matrix.go-version }}
+
+      - name: Checkout code
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+
+      - name: Test
+        run: go test ./...

.github/workflows/push_main.yml

@@ -0,0 +1,29 @@
+---
+name: Release Version
+
+on:  # yamllint disable-line rule:truthy
+  push:
+    branches:
+      - main
+
+jobs:
+  release:
+    name: 'Release to GitHub'
+    runs-on: ubuntu-latest
+    steps:
+
+      - name: Checkout repo
+        uses: actions/checkout@v3
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: lts/*
+
+      - name: Install Semantic Release Plugins
+        run: npm install --save-dev @semantic-release/changelog @semantic-release/git conventional-changelog-conventionalcommits  # yamllint disable-line rule:line-length
+
+      - name: Release Version
+        env:
+          GITHUB_TOKEN: ${{ secrets.GH_RELEASE_PAT }}
+        run: npx semantic-release

.gitignore

@@ -0,0 +1,15 @@
+# Binaries for programs and plugins
+*.exe
+*.exe~
+*.dll
+*.so
+*.dylib
+
+# Test binary, built with `go test -c`
+*.test
+
+# Output of the go coverage tool, specifically when used with LiteIDE
+*.out
+
+# Dependency directories (remove the comment below to include it)
+vendor/

.releaserc

@@ -0,0 +1,10 @@
+---
+branches:
+- master
+- main
+plugins:
+- - "@semantic-release/commit-analyzer"
+  - preset: conventionalcommits
+- - "@semantic-release/release-notes-generator"
+  - preset: conventionalcommits
+- - "@semantic-release/github"

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Michael Peters
+
+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,12 @@
+# Makefile
+all: setup hooks
+
+# requires `nvm use --lts` or `nvm use node`
+.PHONY: setup
+setup: 
+	npm install -g @commitlint/config-conventional @commitlint/cli  
+
+
+.PHONY: hooks
+hooks:
+	@git config --local core.hooksPath .githooks/

README.md

@@ -0,0 +1,2 @@
+# go-lib
+A template repository for Go libraries.

commitlint.config.js

@@ -0,0 +1,6 @@
+module.exports = {
+    extends: ['@commitlint/config-conventional'],
+    ignores: [
+        (message) => message.includes('Initial commit')
+    ],
+  };

go.mod

@@ -0,0 +1,3 @@
+module github.com/michaelpeterswa/go-lib
+
+go 1.18

temp/temp.go

@@ -0,0 +1 @@
+package temp