feat: GitHub Workflow for binaries and container images

Build binaries for all platforms and container manifest images.
Upload binaries to tagged releases.
Push container images to ghcr.io.

Author: ananthb

.github/workflows/release.yml

@@ -0,0 +1,49 @@
+name: Release
+
+on:
+  release:
+    types:
+      - created
+
+  workflow_dispatch:
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  release:
+    name: Release binaries and container images
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-go@v5
+        with:
+          go-version-file: go.mod
+
+      - uses: ko-build/[email protected]
+
+      - name: Build
+        env:
+          VERSION: ${{ github.ref_name }}
+          TAGS: ${{ github.ref_name }},${{ github.sha }},latest
+        shell: bash
+        run: |
+          ./build.sh "$VERSION"
+          export KO_DOCKER_REPO="ghcr.io/${GITHUB_REPOSITORY}"
+          ko build --bare --platform=all --tags=$TAGS .
+
+      - uses: actions/upload-artifact@v3
+        with:
+          name: mikrotik-exporter
+          path: |
+            bin/*
+
+      - uses: softprops/action-gh-release@v1
+        with:
+          append_body: true
+          generate_release_notes: true
+          files: |
+            bin/*

.gitignore

@@ -3,6 +3,7 @@
 *.dll
 *.so
 *.dylib
+bin/
 
 # Test binary, build with `go test -c`
 *.test

Dockerfile

@@ -1,13 +1,8 @@
-[![Docker Pulls](https://img.shields.io/docker/pulls/nshttpd/mikrotik-exporter.svg)](https://hub.docker.com/r/nshttpd/mikrotik-exporter/)
-
-## prometheus-mikrotik
+# prometheus-mikrotik
 
 tl;dr - prometheus exporter for mikrotik devices
 
-This is still a work in progress .. consider `master` at the moment as a preview
-release.
-
-#### Description
+## Description
 
 A Prometheus Exporter for Mikrotik devices. Can be configured to collect metrics
 from a single device or multiple devices. Single device monitoring can be configured
@@ -17,7 +12,7 @@ be required that has read-only access to the device configuration via the API.
 Currently the exporter collects metrics for interfaces and system resources. Others
 can be added as long as published via the API.
 
-#### Mikrotik Config
+## Mikrotik Config
 
 Create a user on the device that has API and read-only access.
 
@@ -31,7 +26,7 @@ Create the user to access the API via.
 
 `/user add name=prometheus group=prometheus password=changeme`
 
-#### Single Device
+## Single Device
 
 `./mikrotik-exporter -address 10.10.0.1 -device my_router -password changeme -user prometheus`
 
@@ -41,19 +36,20 @@ created for the exporter to use to access the API.
 
 User and password flags can be set with the `MIKROTIK_USER` and `MIKROTIK_PASSWORD` environment variables, respectively.
 
-```
+```console
 MIKROTIK_USER=prometheus
 MIKROTIK_PASSWORD=changeme
 ./mikrotik-exporter -address 10.10.0.1 -device my_router
 ```
 
-#### Config File
+## Config File
 
 `./mikrotik-exporter -config-file config.yml`
 
 where `config-file` is the path to a config file in YAML format.
 
-###### example config
+### example config
+
 ```yaml
 devices:
   - name: my_router
@@ -93,10 +89,9 @@ If you add a devices with the `srv` parameter instead of `address` the exporter
 to obtain the SRV record and discover the devices dynamically. Also, you can specify a DNS server to use
 on the query.
 
+## example output
 
-###### example output
-
-```
+```console
 mikrotik_interface_tx_byte{address="10.10.0.1",interface="ether2",name="my_router"} 1.4189902583e+10
 mikrotik_interface_tx_byte{address="10.10.0.1",interface="ether3",name="my_router"} 2.263768666e+09
 mikrotik_interface_tx_byte{address="10.10.0.1",interface="ether4",name="my_router"} 1.6572299e+08
@@ -105,5 +100,3 @@ mikrotik_interface_tx_byte{address="10.10.0.1",interface="ether6",name="my_route
 mikrotik_interface_tx_byte{address="10.10.0.1",interface="ether7",name="my_router"} 3.18354425e+08
 mikrotik_interface_tx_byte{address="10.10.0.1",interface="ether8",name="my_router"} 1.86405031e+08
 ```
-
- 

Dockerfile.arm64

@@ -0,0 +1,49 @@
+#!/bin/bash
+#
+# $1 - The version number to use for the build. If not provided, the current git
+#     commit hash will be used.
+#
+
+set -euo pipefail
+
+app="$(basename "$PWD")"
+
+version="${1:-$(git rev-parse --short HEAD)}"
+
+rm -rf bin
+mkdir -p bin
+pushd bin
+trap popd EXIT
+
+gobuild() {
+  mkdir -p "$1/$2"
+  pushd "$1/$2"
+  env GOOS="$1" GOARCH="$2" go build ../../../.
+  case "$1" in
+    "windows")
+      zip ../../"${app}_${1}_${2}_${version}".zip ./*.exe
+      ;;
+    "linux")
+      tar -c --zstd --numeric-owner \
+        -f ../../"${app}_${1}_${2}_${version}".tar.zst .
+      ;;
+    *)
+      tar -c --numeric-owner \
+        -f ../../"${app}_${1}_${2}_${version}".tar.bz2 .
+      ;;
+  esac
+  rm ./*
+  popd
+  rmdir "${1:?}/${2:?}" "${1:?}"
+}
+
+export CGO_ENABLED=0
+
+# Binaries for all platforms
+gobuild linux amd64
+gobuild linux arm64
+gobuild darwin amd64
+gobuild darwin arm64
+gobuild windows amd64
+
+sha1sum ./*.tar.* ./*.zip >sha1sums.txt

Dockerfile.armhf

@@ -2,7 +2,6 @@ package config
 
 import (
 	"io"
-	"io/ioutil"
 
 	yaml "gopkg.in/yaml.v2"
 )
@@ -54,7 +53,7 @@ type DnsServer struct {
 
 // Load reads YAML from reader and unmashals in Config
 func Load(r io.Reader) (*Config, error) {
-	b, err := ioutil.ReadAll(r)
+	b, err := io.ReadAll(r)
 	if err != nil {
 		return nil, err
 	}

README.md

@@ -2,7 +2,7 @@ package config
 
 import (
 	"bytes"
-	"io/ioutil"
+	"os"
 	"testing"
 )
 
@@ -34,7 +34,7 @@ func TestShouldParse(t *testing.T) {
 }
 
 func loadTestFile(t *testing.T) []byte {
-	b, err := ioutil.ReadFile("config.test.yml")
+	b, err := os.ReadFile("config.test.yml")
 	if err != nil {
 		t.Fatalf("could not load config: %v", err)
 	}

build.sh

@@ -1,15 +1,30 @@
 module mikrotik-exporter
 
-go 1.13
+go 1.22.4
 
 require (
-	github.com/miekg/dns v1.1.43
-	github.com/prometheus/client_golang v1.4.1
-	github.com/prometheus/common v0.9.1
-	github.com/sirupsen/logrus v1.8.1
-	github.com/stretchr/testify v1.4.0
-	golang.org/x/net v0.0.0-20210805182204-aaa1db679c0d // indirect
-	golang.org/x/sys v0.0.0-20210809222454-d867a43fc93e // indirect
+	github.com/miekg/dns v1.1.61
+	github.com/prometheus/client_golang v1.19.1
+	github.com/prometheus/common v0.54.0
+	github.com/sirupsen/logrus v1.9.3
+	github.com/stretchr/testify v1.8.2
 	gopkg.in/routeros.v2 v2.0.0-20190905230420-1bbf141cdd91
 	gopkg.in/yaml.v2 v2.4.0
 )
+
+require (
+	github.com/beorn7/perks v1.0.1 // indirect
+	github.com/cespare/xxhash/v2 v2.3.0 // indirect
+	github.com/davecgh/go-spew v1.1.1 // indirect
+	github.com/kr/text v0.2.0 // indirect
+	github.com/pmezard/go-difflib v1.0.0 // indirect
+	github.com/prometheus/client_model v0.6.1 // indirect
+	github.com/prometheus/procfs v0.15.1 // indirect
+	golang.org/x/mod v0.18.0 // indirect
+	golang.org/x/net v0.26.0 // indirect
+	golang.org/x/sync v0.7.0 // indirect
+	golang.org/x/sys v0.21.0 // indirect
+	golang.org/x/tools v0.22.0 // indirect
+	google.golang.org/protobuf v1.34.2 // indirect
+	gopkg.in/yaml.v3 v3.0.1 // indirect
+)