fmartingr
/
golang-app-template
mirror of https://github.com/fmartingr/golang-app-template.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
5 Commits
1 Branch
1 Tag
143 KiB
 
 
 
 
 
Tag: Branch: Tree: latest
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'latest'
${ noResults }
Go to file
Use this template
Felipe M c127235880
docs: added basic readme file 		10 months ago
.github/workflows docs: added comment to push_version workflow 10 months ago
cmd/golang-app-template Initial template (from fmartingr/bazaar) 10 months ago
helm Initial template (from fmartingr/bazaar) 10 months ago
scripts Initial template (from fmartingr/bazaar) 10 months ago
.gitignore Initial template (from fmartingr/bazaar) 10 months ago
.goreleaser.yml Initial template (from fmartingr/bazaar) 10 months ago
Containerfile Initial template (from fmartingr/bazaar) 10 months ago
Makefile fix: ignore error on dockerx build rm 10 months ago
README.md docs: added basic readme file 10 months ago
go.mod Initial template (from fmartingr/bazaar) 10 months ago

README.md

golang-app-template

Golang application template for GitHub.

Contains:

  • Basic running Go code (just a cmd so everything else works)
  • A Makefile with some Quality of Life for contributing and executing common tasks.
  • A Containerfile with a boilerplate container with no dependencies.
  • Goreleaser configuration and CI.
  • A basic Helm chart
  • Github actions to build, test and release binaries and container images to the Github container registry.

Using the template

  1. Press the Use this template button at the top of this repository.
  2. Find and replace golang-app-template everywhere you need
  3. Rename cmd/golang-app-template
  4. make quick-run

Makefile

$ make help
         build: builds the project for the setup os/arch combinations
         clean:  clean test cache, build files
        format: Executes the formatting pipeline on the project
          help: this screen. Keep it first target to be default
          lint: Check the project for errors
     quick-run: Executes the project using golang
           run: Executes the project build locally
          test: Runs the test suite