Use GoReleaser to release and publish cortextool (#84)

* Use GoReleaser to release and publish cortextools

Author: gotjosh

.goreleaser.yml

@@ -0,0 +1,83 @@
+before:
+  hooks:
+    - go mod download
+    # you may remove this if you don't need go generate
+    - go generate ./...
+project_name: cortextool
+builds:
+  - id: cortextool-darwin
+    ldflags:
+      -s -w -X github.com/grafana/cortex-tools/pkg/version.Version={{.Version}}
+    binary: cortextool
+    env:
+      - CGO_ENABLED=0
+    main: ./cmd/cortextool/main.go
+    goos:
+      - darwin
+    goarch:
+      - amd64
+  - id: cortextool-linux
+    ldflags:
+      -s -w -X github.com/grafana/cortex-tools/pkg/version.Version={{.Version}}
+    binary: cortextool
+    env:
+      - CGO_ENABLED=0
+    main: ./cmd/cortextool/main.go
+    goos:
+      - linux
+    goarch:
+      - amd64
+  - id: cortextool-windows
+    ldflags:
+      -s -w -X github.com/grafana/cortex-tools/pkg/version.Version={{.Version}}
+    binary: cortextool
+    env:
+      - CGO_ENABLED=0
+    main: ./cmd/cortextool/main.go
+    goos:
+      - windows
+    goarch:
+      - amd64
+      - 386
+archives:
+  - replacements:
+      darwin: mac-os
+      linux: linux
+      windows: windows
+      386: i386
+      amd64: x86_64
+    format_overrides:
+      - goos: windows
+        format: zip
+    files:
+      - none*
+    format: binary
+checksum:
+  name_template: 'checksums.txt'
+snapshot:
+  name_template: "{{ .Tag }}-next"
+changelog:
+  sort: asc
+  filters:
+    exclude:
+      - '^docs:'
+      - '^test:'
+dockers:
+  - goos: linux
+    goarch: amd64
+    binaries:
+      - cortextool
+    builds:
+      - cortextool-linux
+    dockerfile: cmd/cortextool/GR.Dockerfile
+    image_templates:
+      - "grafana/cortex-tools:latest"
+      - "grafana/cortex-tools:{{ .Tag }}"
+    build_flag_templates:
+    - "--pull"
+    - "--label=org.opencontainers.image.created={{.Date}}"
+    - "--label=org.opencontainers.image.name={{.ProjectName}}"
+    - "--label=org.opencontainers.image.revision={{.FullCommit}}"
+    - "--label=org.opencontainers.image.version={{.Version}}"
+    - "--label=repository=https://github.com/grafana/cortex-tools"
+    - "--label=homepage=https://grafana.com"

CHANGELOG.md

@@ -2,8 +2,9 @@
 
 ## unreleased / master
 
-* [FEATURE] Added loki backend support for the rules commands, configurable with `--backend=loki` (defaults to cortex).
+## v0.3.0
 
+* [FEATURE] Added loki backend support for the rules commands, configurable with `--backend=loki` (defaults to cortex).
 ## v0.2.4
 
 * [BUGFIX] Fix alertmanager registration subcommand and path for the configuration API #72

RELEASE.md

@@ -1,4 +1,21 @@
-# Steps to create the release:
+# Release processes
+
+## GoReleaser (`cortextool` only)
+
+1. Create a changelog file in `changelog/` with the name of the tag e.g. `changelog/v0.3.0.md`. This will be used as the template for the release page in GitHub.
+2. Create a new tag that follows semantic versioning:
+
+```bash
+$ tag=v0.3.0
+$ git tag -s "${tag}" -m "${tag}"
+$ git push origin "${tag}"
+```
+
+3. Run `$ goreleaser --release-notes=changelogs/v0.3.0.md --rm-dist` where the changelog file is the one created as part of step 1.
+4. The docker image will be pushed automatically.
+
+
+## Manual (all the other binaries)
 
 1. Manually build and test the new additions
 2. Create a new tag based on:  

changelogs/v0.3.0.md

@@ -0,0 +1,18 @@
+# Changes
+
+* [FEATURE] Added loki backend support for the rules commands, configurable with `--backend=loki` (defaults to cortex).
+* [FEATURE] Introduces a new `version` command. The command will also let you know if there's a new version available.
+
+# Installation
+
+## cortextool
+```
+# download the binary (adapt os and arch as needed)
+$ curl -fSL -o "/usr/local/bin/cortextool" "https://github.com/grafana/cortex-tools/releases/download/v0.3.0/cortextool_0.3.0_linux_x86_64"
+
+# make it executable
+$ chmod a+x "/usr/local/bin/cortextool"
+
+# have fun :)
+$ cortextool --help
+```

cmd/cortextool/GR.Dockerfile

@@ -0,0 +1,5 @@
+FROM       alpine:3.9
+RUN        apk add --update --no-cache ca-certificates
+COPY       cortextool /usr/bin/cortextool
+EXPOSE     80
+ENTRYPOINT [ "/usr/bin/cortextool" ]

cmd/cortextool/main.go

@@ -1,11 +1,13 @@
 package main
 
 import (
+	"fmt"
 	"os"
 
 	"gopkg.in/alecthomas/kingpin.v2"
 
 	"github.com/grafana/cortex-tools/pkg/commands"
+	"github.com/grafana/cortex-tools/pkg/version"
 )
 
 var (
@@ -18,14 +20,21 @@ var (
 )
 
 func main() {
-	kingpin.Version("0.1.3")
 	app := kingpin.New("cortextool", "A command-line tool to manage cortex.")
 	logConfig.Register(app)
 	alertCommand.Register(app)
 	alertmanagerCommand.Register(app)
 	ruleCommand.Register(app)
 	pushGateway.Register(app)
 	loadgenCommand.Register(app)
+
+	app.Command("version", "Get the version of the cortextool CLI").Action(func(k *kingpin.ParseContext) error {
+		fmt.Print(version.Template)
+		version.CheckLatest()
+
+		return nil
+	})
+
 	kingpin.MustParse(app.Parse(os.Args[1:]))
 
 	pushGateway.Stop()

go.mod

@@ -12,6 +12,7 @@ require (
 	github.com/gogo/protobuf v1.3.1
 	github.com/golang/snappy v0.0.1
 	github.com/google/go-cmp v0.4.0
+	github.com/google/go-github/v32 v32.1.0
 	github.com/grafana/loki v1.6.2-0.20200831213751-f905e77259f2
 	github.com/mitchellh/colorstring v0.0.0-20190213212951-d06e56a500db
 	github.com/opentracing/opentracing-go v1.2.0

go.sum

@@ -525,7 +525,10 @@ github.com/google/go-cmp v0.3.0/go.mod h1:8QqcDgzrUqlUb/G2PQTWiueGozuR1884gddMyw
 github.com/google/go-cmp v0.3.1/go.mod h1:8QqcDgzrUqlUb/G2PQTWiueGozuR1884gddMywk6iLU=
 github.com/google/go-cmp v0.4.0 h1:xsAVV57WRhGj6kEIi8ReJzQlHHqcBYCElAvkovg3B/4=
 github.com/google/go-cmp v0.4.0/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE=
+github.com/google/go-github v17.0.0+incompatible h1:N0LgJ1j65A7kfXrZnUDaYCs/Sf4rEjNlfyDHW9dolSY=
 github.com/google/go-github v17.0.0+incompatible/go.mod h1:zLgOLi98H3fifZn+44m+umXrS52loVEgC2AApnigrVQ=
+github.com/google/go-github/v32 v32.1.0 h1:GWkQOdXqviCPx7Q7Fj+KyPoGm4SwHRh8rheoPhd27II=
+github.com/google/go-github/v32 v32.1.0/go.mod h1:rIEpZD9CTDQwDK9GDrtMTycQNA4JU3qBsCizh3q2WCI=
 github.com/google/go-querystring v1.0.0 h1:Xkwi/a1rcvNg1PPYe5vI8GbeBY/jrVuDX5ASuANWTrk=
 github.com/google/go-querystring v1.0.0/go.mod h1:odCYkC5MyYFN7vkCjXpyrEuKhc/BUO6wN/zVPAxq5ck=
 github.com/google/gofuzz v0.0.0-20161122191042-44d81051d367/go.mod h1:HP5RmnzzSNb993RKQDq4+1A4ia9nllfqcQFTQJedwGI=
@@ -1486,6 +1489,7 @@ google.golang.org/api v0.26.0 h1:VJZ8h6E8ip82FRpQl848c5vAadxlTXrUh8RzQzSRm08=
 google.golang.org/api v0.26.0/go.mod h1:lIXQywCXRcnZPGlsd8NbLnOjtAoL6em04bJ9+z0MncE=
 google.golang.org/api v0.29.0 h1:BaiDisFir8O4IJxvAabCGGkQ6yCJegNQqSVoYUNAnbk=
 google.golang.org/api v0.29.0/go.mod h1:Lcubydp8VUV7KeIHD9z2Bys/sm/vGKnG1UHuDBSrHWM=
+google.golang.org/appengine v1.1.0/go.mod h1:EbEs0AVv82hx2wNQdGPgUI5lhzA/G0D9YwlJXL52JkM=
 google.golang.org/appengine v1.2.0/go.mod h1:xpcJRLb0r/rnEns0DIKYYv+WjYCduHsrkT7/EB5XEv4=
 google.golang.org/appengine v1.3.0/go.mod h1:xpcJRLb0r/rnEns0DIKYYv+WjYCduHsrkT7/EB5XEv4=
 google.golang.org/appengine v1.4.0/go.mod h1:xpcJRLb0r/rnEns0DIKYYv+WjYCduHsrkT7/EB5XEv4=

pkg/version/version.go

@@ -0,0 +1,41 @@
+package version
+
+import (
+	"context"
+	"fmt"
+	"strings"
+
+	"github.com/google/go-github/v32/github"
+	log "github.com/sirupsen/logrus"
+)
+
+// Version defines the version for the binary, this is actually set by GoReleaser.
+var Version = "master"
+
+// Template controls how the version is displayed
+var Template = fmt.Sprintf("version %s\n", Version)
+
+// CheckLatest asks GitHub
+func CheckLatest() {
+	if Version != "master" {
+		latest := getLatestFromGitHub()
+		version := Version
+		if latest != "" && (strings.TrimPrefix(latest, "v") != strings.TrimPrefix(version, "v")) {
+			fmt.Printf("A newer version of cortextool is available, please update to %s\n", latest)
+		} else {
+			fmt.Println("You are on the latest version")
+		}
+	}
+}
+
+func getLatestFromGitHub() string {
+	fmt.Print("checking latest version... ")
+	c := github.NewClient(nil)
+	resp, _, err := c.Repositories.GetLatestRelease(context.Background(), "grafana", "cortex-tools")
+
+	if err != nil {
+		log.WithFields(log.Fields{"err": err}).Debugln("failed to retrieve latest version")
+	}
+
+	return *resp.TagName
+}