This repository contains useful CI/CD pipelines, CONTRIBUTING, predefined Dockerfile and versioning for Go repositories but it could be easily adapted to other project structures as well.
Make sure you configure your repository before coding your project.
| File | Description |
|---|---|
| Dockerfile | Update the default Dockerfile for your specific project, by default it compiles your main binary (if the main.go is located at the root of the repo) and executes it by default. |
| README.md | Update this README file to properly document your own repository. |
| build.yaml | Make sure you updated the lines 39 and 40 with your Git identity. Also update the Go version as it is in your own go.mod |
| go.mod | Delete this file and place your own go.mod |
You will need to setup two Actions Secrets to make use of the Coverage features provided by Codecov - The Leading Code Coverage Solution.
| Secret | Description and setup |
|---|---|
DEVOPS_TOKEN |
GitHub access token with permissions to Write Packages |
CODECOV_TOKEN |
Your Codecov repository access token. |
You will find the entire documentation for this project at docs/.
| File | Description |
|---|---|
| docs/README.md | Detailed description of the documentation files. |
| CONTRIBUTING.md | Rules for contributing to this repository. Including commit nomenclature, code quality and more. |
| CHANGELOG.md | This file is autogenerated by the Build Action's pipeline, should never be modified manually. |