go-ci-release-repository
Simple template of go repository with workflow for ci and release
Usage
In main branch contains base repository without workflow of release artifacts and docs.
In docs branch add workflow for generating mkdocs.
In artifacts branch add workflow for generating release with artifacts as binaries.
You can merge needed branches to main to add new workflow functional.
Version expected start with v[n].[n].[n]*, where [n] is any digit. Example v0.0.1-alpha.
Artifacts
If you want to print version from your app with --version flag, you can use version from file version\version.go.
When artifacts will build, information about the build platform will be added to the version in this file.
Example it will be v0.0.1 darwin/arm.
Docs
Mkdocs is used as docs engine. All pages of docs is stored in docs directory.
Additionally, in the current version, an extension has been added that allows you to connect documentation comments with discussions in github. This extension can be changed or deleted at will.