Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jandelgado/golang-ci-template-github-actions
example for golang project using github actions
https://github.com/jandelgado/golang-ci-template-github-actions
ci coverage coveralls docker github-actions golang goreleaser
Last synced: 1 day ago
JSON representation
example for golang project using github actions
- Host: GitHub
- URL: https://github.com/jandelgado/golang-ci-template-github-actions
- Owner: jandelgado
- License: mit
- Created: 2019-09-29T20:31:18.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-11-10T15:09:42.000Z (about 2 months ago)
- Last Synced: 2024-12-24T15:14:04.140Z (15 days ago)
- Topics: ci, coverage, coveralls, docker, github-actions, golang, goreleaser
- Language: Dockerfile
- Homepage:
- Size: 1.02 MB
- Stars: 57
- Watchers: 4
- Forks: 41
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# golang ci template using github actions
[](https://github.com/jandelgado/golang-ci-template-github-actions/actions?workflow=test%20and%20build)
[](https://coveralls.io/github/jandelgado/golang-ci-template-github-actions?branch=master)
[](https://goreportcard.com/report/github.com/jandelgado/golang-ci-template-github-actions)
* [Info](#info)
* [Dependabot](#dependabot)
* [Creating a release](#creating-a-release)
* [Test coverage (coveralls)](#test-coverage-coveralls)
* [Author](#author)
## Info
This repository serves as a template for github-actions integrated go projects.
It consists of a `hello, world!` like example in source file [main.go](main.go)
which gets compiled into the binary `golang-ci-template-github-actions`. The CI
runs some [linters](https://github.com/golangci/golangci-lint-action) on the
code, before the unit tests are executed. Test coverage is uploaded to
coveralls.io.
[goreleaser](https://github.com/goreleaser/goreleaser) is used to create the
final multi-plattform assets, which are automatically uploaded to the
[release](https://github.com/jandelgado/golang-ci-template-github-actions/releases/latest).
The [release-process](#creating-a-release) is triggered by pushing a git tag to
the repository.
Finally, a docker image is built, which gets published to
[ghcr.io](https://github.com/jandelgado/golang-ci-template-github-actions/pkgs/container/golang-ci-template-github-actions).
Run it with
```console
$ docker run --rm ghcr.io/jandelgado/golang-ci-template-github-actions:latest
hello, world!
```
## Dependabot
We use [dependabot](https://docs.github.com/en/code-security/dependabot) to
both keep the go dependencies as well as the used github action up-to-date.
The configuration can be found [here](.github/dependabot.yml).
## Creating a release
A new release is created by creating a git tag and pushing it, e.g.:
```console
$ git tag -a "v1.2.3" -m "this is release v1.2.3"
$ git push origin v1.2.3
```
The push of the new tag triggers the CI, which uses goreleaser to:
* build multiplatform release artifacts
* create a new release
* upload the artifacts, which are then available on the [releases page](/jandelgado/golang-ci-template-github-actions/releases).
Finally, a docker image is built, which gets published to
[ghcr.io](https://github.com/jandelgado/golang-ci-template-github-actions/pkgs/container/golang-ci-template-github-actions).
## Test coverage (coveralls)
We use the
[coveralls-github-action](https://github.com/coverallsapp/github-action) to
upload the golang coverage to coveralls.
Don't forget to enable `Leave comments (x) ` in coveralls, under `repo
settings` > `pull request alerts`, so that the coveralls-action posts a comment
with the test coverage to affected pull requests:
## Author
(c) copyright 2021 by Jan Delgado, License MIT