https://github.com/theflyingcodr/go-lib-template

A common template I use when creating go libraries
https://github.com/theflyingcodr/go-lib-template

Last synced: 9 days ago
JSON representation

A common template I use when creating go libraries

• Host: GitHub
• URL: https://github.com/theflyingcodr/go-lib-template
• Owner: theflyingcodr
• License: mit
• Created: 2021-08-12T20:41:58.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2021-08-25T08:54:54.000Z (about 3 years ago)
• Last Synced: 2023-03-05T23:38:31.061Z (over 1 year ago)
• Language: Makefile
• Size: 43 KB
• Stars: 2
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# go-lib-template

![GitHub Workflow Status](https://img.shields.io/github/workflow/status/theflyingcodr/go-lib-template/Go?style=flat-square)

![GitHub](https://img.shields.io/github/license/theflyingcodr/go-lib-template?style=flat-square)

![GitHub go.mod Go version](https://img.shields.io/github/go-mod/go-version/theflyingcodr/go-lib-template?style=flat-square)

[![Report](https://goreportcard.com/badge/github.com/theflyingcodr/go-lib-template?style=flat&v=1)](https://goreportcard.com/report/github.com/theflyingcodr/go-lib-template)

![GitHub release (latest by date)](https://img.shields.io/github/v/release/theflyingcodr/go-lib-template?style=flat-square)

A git template that can be used to bootstrap a go library, ie, something that isn't an executable.

This comes complete with git actions for:

* greetings  - welcome new contributors automatically

* build & release - to ensure your code is building before creating a release

* code quality - to scan for obvious issues

There is also a [Makefile](Makefile) with some handy common commands for running all tests, testing the releaser etc.

This will hopefully make a good starting point when you are looking to start a new go project.

## Getting started

* Create a new github repo

* Select this as the template

* Clone the repo

* run `go mod init github.com/youruser/yourporject`

* code code code

## Build pipeline

The go build will run on PRs and when pushed to master. When you tag master it will then run the go build and then create a release.

## Mergify

It also has a mergify config if you run that on your repos for auto merging etc.

Lets see if it works. Hmm