You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+14-6Lines changed: 14 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -18,7 +18,6 @@ It includes:
18
18
- dependency management using [Go Modules](https://github.com/golang/go/wiki/Modules),
19
19
- linting with [golangci-lint](https://github.com/golangci/golangci-lint),
20
20
- unit testing with [race detector](https://blog.golang.org/race-detector) and [code covarage HTML report](https://blog.golang.org/cover),
21
-
- auto-tagging via [Github Tag Bump](https://github.com/marketplace/actions/github-tag-bump) GitHub Action,
22
21
- releasing using [GoReleaser](https://github.com/goreleaser/goreleaser),
23
22
- depdendencies scanning and vulnerabilities alerting thanks to [Dependabot](https://dependabot.com/go/),
24
23
-[Visual Studio Code](https://code.visualstudio.com) configuration with [Go](https://code.visualstudio.com/docs/languages/go) and [Remote Container](https://code.visualstudio.com/docs/remote/containers) support.
@@ -43,10 +42,7 @@ It includes:
43
42
44
43
The release workflow is triggered each time a tag with `v` prefix is pushed.
45
44
46
-
This repo uses [Github Tag Bump](https://github.com/marketplace/actions/github-tag-bump) for auto tagging on master branch. Therfore, it automatically triggers the release workflow as well.
47
-
48
-
- Add `#minor` to your commit message to bump minor version.
49
-
- Add `#major` to your commit message to bump major version. DANGER! Use it with caution and make sure you understand the consequences. More info: [Go Wiki](https://github.com/golang/go/wiki/Modules#releasing-modules-v2-or-higher), [Go Blog](https://blog.golang.org/v2-go-modules).
45
+
_CAUTION_: Make sure to understand the consequences before you bump the major version. More info: [Go Wiki](https://github.com/golang/go/wiki/Modules#releasing-modules-v2-or-higher), [Go Blog](https://blog.golang.org/v2-go-modules).
@@ -122,6 +119,17 @@ Alternativly you can completly remove the usage of GoReleaser if you prefer hand
122
119
123
120
By default `go test` records code coverage for the package that is currently tested. If you want to get more accurate (cross-package) coverage, then consider using [go-acc](https://github.com/ory/go-acc). [Read more](https://www.ory.sh/golang-go-code-coverage-accurate/).
124
121
122
+
### How to automate generating git tags for next release version
123
+
124
+
Auto-tagging can be done e.g. by using GitHub Actions like:
125
+
126
+
- [Github Tag Bump](https://github.com/marketplace/actions/github-tag-bump),
There are many possibilites how it can be achieved. Creating release tags manually is often the optimal approach. Take notice that this template executes a release workflow each time a git tag with `v` prefix is pushed.
0 commit comments