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
This is a GitHub repository template for Go. It has been created for ease-of-use for anyone who wants to:
12
+
⭐ `Star` this repository if you find it valuable and worth maintaining.
13
13
14
-
- quickly get into Go without losing too much time on environment setup,
15
-
- create a new repoisitory with basic Continuous Integration.
14
+
👁 `Watch` this repository to get notified about new releases, issues, etc.
15
+
16
+
## Description
17
+
18
+
This is a GitHub repository template for a Go application.
19
+
You can use it:
20
+
21
+
- to create a new repoisitory with automation and environment setup,
22
+
- as reference when improving automation for an existing repository.
16
23
17
24
It includes:
18
25
@@ -31,13 +38,10 @@ It includes:
31
38
- security code analysis using [CodeQL Action](https://docs.github.com/en/github/finding-security-vulnerabilities-and-errors-in-your-code/about-code-scanning),
32
39
-[Visual Studio Code](https://code.visualstudio.com) configuration with [Go](https://code.visualstudio.com/docs/languages/go) support.
33
40
34
-
`Star` this repository if you find it valuable and worth maintaining.
35
-
36
-
`Watch` this repository to get notified about new releases, issues, etc.
37
-
38
41
## Usage
39
42
40
-
1. Sign up on [Codecov](https://codecov.io/) and configure [Codecov GitHub Application](https://github.com/apps/codecov) for all repositories.
43
+
1. Sign up on [Codecov](https://codecov.io/) and configure
44
+
[Codecov GitHub Application](https://github.com/apps/codecov) for all repositories.
41
45
1. Click the `Use this template` button (alt. clone or download this repository).
42
46
1. Replace all occurrences of `golang-templates/seed` to `your_org/repo_name` in all files.
43
47
1. Replace all occurrences of `seed` to `repo_name` in [Dockerfile](Dockerfile).
@@ -50,7 +54,10 @@ It includes:
50
54
## Setup
51
55
52
56
Below you can find sample instructions on how to set up the development environment.
53
-
Of course you can use other tools like [GoLand](https://www.jetbrains.com/go/), [Vim](https://github.com/fatih/vim-go), [Emacs](https://github.com/dominikh/go-mode.el). However take notice that the Visual Studio Go extension is [officially supported](https://blog.golang.org/vscode-go) by the Go team.
57
+
Of course, you can use other tools like [GoLand](https://www.jetbrains.com/go/),
However, take notice that the Visual Studio Go extension is
60
+
[officially supported](https://blog.golang.org/vscode-go) by the Go team.
54
61
55
62
1. Install [Go](https://golang.org/doc/install).
56
63
1. Install [Visual Studio Code](https://code.visualstudio.com/).
@@ -73,7 +80,9 @@ Of course you can use other tools like [GoLand](https://www.jetbrains.com/go/),
73
80
74
81
The release workflow is triggered each time a tag with `v` prefix is pushed.
75
82
76
-
_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).
83
+
_CAUTION_: Make sure to understand the consequences before you bump the major version.
84
+
More info: [Go Wiki](https://github.com/golang/go/wiki/Modules#releasing-modules-v2-or-higher),
85
+
[Go Blog](https://blog.golang.org/v2-go-modules).
77
86
78
87
## Maintenance
79
88
@@ -135,8 +144,10 @@ how it is dogfooding its functionality.
135
144
You can use it to add deb/rpm/snap packages, Homebrew Tap, Scoop App Manifest etc.
136
145
137
146
If you are developing a library and you like handcrafted changelog and release notes,
138
-
you free to remove any usage of GoReleaser.
147
+
you are free to remove any usage of GoReleaser.
139
148
140
149
## Contributing
141
150
142
-
Simply create an issue or a pull request.
151
+
Feel free to create an issue or propose a pull request.
0 commit comments