https://github.com/ks6088ts/template-go

A GitHub template repository for Go
https://github.com/ks6088ts/template-go

cobra docker go golangci-lint hadolint trivy

Last synced: 28 days ago
JSON representation

A GitHub template repository for Go

• Host: GitHub
• URL: https://github.com/ks6088ts/template-go
• Owner: ks6088ts
• License: mit
• Created: 2024-03-16T06:06:14.000Z (8 months ago)
• Default Branch: main
• Last Pushed: 2024-09-11T00:28:33.000Z (about 2 months ago)
• Last Synced: 2024-09-13T01:21:38.199Z (about 2 months ago)
• Topics: cobra, docker, go, golangci-lint, hadolint, trivy
• Language: Go
• Homepage: https://hub.docker.com/repository/docker/ks6088ts/template-go/tags?page=1&ordering=last_updated
• Size: 66.4 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: .github/CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: .github/CODE_OF_CONDUCT.md
  • Codeowners: .github/CODEOWNERS
  • Security: .github/SECURITY.md

Awesome Lists containing this project

README

        
[![test](https://github.com/ks6088ts/template-go/actions/workflows/test.yaml/badge.svg?branch=main)](https://github.com/ks6088ts/template-go/actions/workflows/test.yaml?query=branch%3Amain)

[![release](https://github.com/ks6088ts/template-go/actions/workflows/release.yaml/badge.svg)](https://github.com/ks6088ts/template-go/actions/workflows/release.yaml)

[![Go Report Card](https://goreportcard.com/badge/github.com/ks6088ts/template-go)](https://goreportcard.com/report/github.com/ks6088ts/template-go)

[![Go Reference](https://pkg.go.dev/badge/github.com/ks6088ts/template-go.svg)](https://pkg.go.dev/github.com/ks6088ts/template-go)

[![docker](https://github.com/ks6088ts/template-go/actions/workflows/docker.yaml/badge.svg?branch=main)](https://github.com/ks6088ts/template-go/actions/workflows/docker.yaml?query=branch%3Amain)

[![docker-release](https://github.com/ks6088ts/template-go/actions/workflows/docker-release.yaml/badge.svg)](https://github.com/ks6088ts/template-go/actions/workflows/docker-release.yaml)

[![ghcr-release](https://github.com/ks6088ts/template-go/actions/workflows/ghcr-release.yaml/badge.svg)](https://github.com/ks6088ts/template-go/actions/workflows/ghcr-release.yaml)

# template-go

A GitHub template repository for Go

## Prerequisites

- [Go 1.21+](https://go.dev/doc/install)

- [GNU Make](https://www.gnu.org/software/make/)

## Development instructions

### Local development

Use Makefile to run the project locally.

```shell

# help

make

# install dependencies for development

make install-deps-dev

# run tests

make test

# build applications

make build

# run CI tests

make ci-test

# release applications

make release

```

### Docker development

```shell

# build docker image

make docker-build

# run docker container

make docker-run

# run CI tests in docker container

make ci-test-docker

```

To publish the docker image to Docker Hub, you need to set the following secrets in the repository settings.

```shell

gh secret set DOCKERHUB_USERNAME --body $DOCKERHUB_USERNAME

gh secret set DOCKERHUB_TOKEN --body $DOCKERHUB_TOKEN

```