Skip to content

asphaltbuffet/shortshorts

Repository files navigation

shortshorts - A service to convey MQTT messages into a timescale DB instance

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

Usage

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

F1Tasks: Run Build Task (Ctrl+Shift+B or ⇧⌘B) to execute the build pipeline.

Release

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

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

FAQ

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.

Contributing

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

Follow the Code of Conduct.