ProductPromotion
Logo

Go.Lang

made by https://0x3d.site

GitHub - golang-templates/seed: Go application GitHub repository template.
Go application GitHub repository template. Contribute to golang-templates/seed development by creating an account on GitHub.
Visit Site

GitHub - golang-templates/seed: Go application GitHub repository template.

GitHub - golang-templates/seed: Go application GitHub repository template.

Go Repository Template

Keep a Changelog GitHub Release Go Reference go.mod LICENSE Build Status Go Report Card Codecov

โญ Star this repository if you find it valuable and worth maintaining.

๐Ÿ‘ Watch this repository to get notified about new releases, issues, etc.

Description

This is a GitHub repository template for a Go application. You can use it:

  • to create a new repository with automation and environment setup,
  • as reference when improving automation for an existing repository.

It includes:

Usage

  1. Sign up on Codecov and configure Codecov GitHub Application.
  2. Click the Use this template button (alt. clone or download this repository).
  3. Replace all occurrences of golang-templates/seed to your_org/repo_name in all files.
  4. Replace all occurrences of seed to repo_name in Dockerfile.
  5. Follow these instructions to add the CODECOV_TOKEN GitHub Actions and Dependabot secret.
  6. Update the following files:

Setup

Below you can find sample instructions on how to set up the development environment. Of course, you can use other tools like GoLand, Vim, Emacs. However, take notice that the Visual Studio Go extension is officially supported by the Go team.

  1. Install Go.
  2. Install Visual Studio Code.
  3. Install Go extension.
  4. Clone and open this repository.
  5. F1 -> Go: Install/Update Tools -> (select all) -> OK.

Build

Terminal

  • make - execute the build pipeline.
  • make help - print help for the Make targets.

Visual Studio Code

F1 โ†’ Tasks: Run Build Task (Ctrl+Shift+B or โ‡งโŒ˜B) to execute the build pipeline.

Release

The release workflow is triggered each time a tag with v prefix is pushed.

CAUTION: Make sure to understand the consequences before you bump the major version. More info: Go Wiki, Go Blog.

Maintenance

Notable files:

FAQ

Why Visual Studio Code editor configuration

Developers that use Visual Studio Code can take advantage of the editor configuration. While others do not have to care about it. Setting configs for each repo is unnecessary time consuming. VS Code is the most popular Go editor (survey) and it is officially supported by the Go team.

You can always remove the .vscode directory if it really does not help you.

Why GitHub Actions, not any other CI server

GitHub Actions is out-of-the-box if you are already using GitHub. Here you can learn how to use it for Go.

However, changing to any other CI server should be very simple, because this repository has build logic and tooling installation in Makefile.

How can I build on Windows

Install tdm-gcc and copy C:\TDM-GCC-64\bin\mingw32-make.exe to C:\TDM-GCC-64\bin\make.exe. Alternatively, you may install mingw-w64 and copy mingw32-make.exe accordingly.

Take a look here, if you have problems using Docker in Git Bash.

You can also use WSL (Windows Subsystem for Linux) or develop inside a Remote Container. However, take into consideration that then you are not going to use "bare-metal" Windows.

Consider using goyek for creating cross-platform build pipelines in Go.

How can I customize the release

Take a look at GoReleaser docs as well as its repo how it is dogfooding its functionality. You can use it to add deb/rpm/snap packages, Homebrew Tap, Scoop App Manifest etc.

If you are developing a library and you like handcrafted changelog and release notes, you are free to remove any usage of GoReleaser.

Contributing

Feel free to create an issue or propose a pull request.

Follow the Code of Conduct.

Articles
to learn more about the golang concepts.

Resources
which are currently available to browse on.

mail [email protected] to add your project or resources here ๐Ÿ”ฅ.

FAQ's
to know more about the topic.

mail [email protected] to add your project or resources here ๐Ÿ”ฅ.

Queries
or most google FAQ's about GoLang.

mail [email protected] to add more queries here ๐Ÿ”.

More Sites
to check out once you're finished browsing here.

0x3d
https://www.0x3d.site/
0x3d is designed for aggregating information.
NodeJS
https://nodejs.0x3d.site/
NodeJS Online Directory
Cross Platform
https://cross-platform.0x3d.site/
Cross Platform Online Directory
Open Source
https://open-source.0x3d.site/
Open Source Online Directory
Analytics
https://analytics.0x3d.site/
Analytics Online Directory
JavaScript
https://javascript.0x3d.site/
JavaScript Online Directory
GoLang
https://golang.0x3d.site/
GoLang Online Directory
Python
https://python.0x3d.site/
Python Online Directory
Swift
https://swift.0x3d.site/
Swift Online Directory
Rust
https://rust.0x3d.site/
Rust Online Directory
Scala
https://scala.0x3d.site/
Scala Online Directory
Ruby
https://ruby.0x3d.site/
Ruby Online Directory
Clojure
https://clojure.0x3d.site/
Clojure Online Directory
Elixir
https://elixir.0x3d.site/
Elixir Online Directory
Elm
https://elm.0x3d.site/
Elm Online Directory
Lua
https://lua.0x3d.site/
Lua Online Directory
C Programming
https://c-programming.0x3d.site/
C Programming Online Directory
C++ Programming
https://cpp-programming.0x3d.site/
C++ Programming Online Directory
R Programming
https://r-programming.0x3d.site/
R Programming Online Directory
Perl
https://perl.0x3d.site/
Perl Online Directory
Java
https://java.0x3d.site/
Java Online Directory
Kotlin
https://kotlin.0x3d.site/
Kotlin Online Directory
PHP
https://php.0x3d.site/
PHP Online Directory
React JS
https://react.0x3d.site/
React JS Online Directory
Angular
https://angular.0x3d.site/
Angular JS Online Directory