Go to file Use this template
Felipe M c127235880
docs: added basic readme file
2022-08-15 20:55:53 +02:00
.github/workflows docs: added comment to push_version workflow 2022-08-13 09:49:16 +02:00
cmd/golang-app-template Initial template (from fmartingr/bazaar) 2022-08-13 08:32:14 +02:00
helm Initial template (from fmartingr/bazaar) 2022-08-13 08:32:14 +02:00
scripts Initial template (from fmartingr/bazaar) 2022-08-13 08:32:14 +02:00
.gitignore Initial template (from fmartingr/bazaar) 2022-08-13 08:32:14 +02:00
.goreleaser.yml Initial template (from fmartingr/bazaar) 2022-08-13 08:32:14 +02:00
Containerfile Initial template (from fmartingr/bazaar) 2022-08-13 08:32:14 +02:00
Makefile fix: ignore error on dockerx build rm 2022-08-13 11:05:16 +02:00
README.md docs: added basic readme file 2022-08-15 20:55:53 +02:00
go.mod Initial template (from fmartingr/bazaar) 2022-08-13 08:32:14 +02:00

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