feat: Version (#141)

* wip

Signed-off-by: Alex Jones <[email protected]>

* fumped

Signed-off-by: Alex Jones <[email protected]>

* needs testing

Signed-off-by: Alex Jones <[email protected]>

* feat: added support for environment variables (#142)

* Added support for environment variables. Documented configurability.

Signed-off-by: Skye Gill <[email protected]>

* Prefix environment variables with FLAGD_

Signed-off-by: Skye Gill <[email protected]>

Signed-off-by: Skye Gill <[email protected]>
Signed-off-by: Alex Jones <[email protected]>

* docs: add install instructions (#143)

* add install instructions

s

Signed-off-by: Michael Beemer <[email protected]>

* Update README.md

Co-authored-by: Todd Baert <[email protected]>
Signed-off-by: Michael Beemer <[email protected]>

* add note about systemd

Signed-off-by: Michael Beemer <[email protected]>

* move configuration options link

Signed-off-by: Michael Beemer <[email protected]>

Signed-off-by: Michael Beemer <[email protected]>
Co-authored-by: Todd Baert <[email protected]>
Signed-off-by: Alex Jones <[email protected]>

* Create CODEOWNERS

Signed-off-by: Alex Jones <[email protected]>

* addressing concerns

Signed-off-by: Alex Jones <[email protected]>

* fumpt

Signed-off-by: Alex Jones <[email protected]>

Signed-off-by: Alex Jones <[email protected]>
Signed-off-by: Skye Gill <[email protected]>
Signed-off-by: Michael Beemer <[email protected]>
Co-authored-by: Skye Gill <[email protected]>
Co-authored-by: Michael Beemer <[email protected]>
Co-authored-by: Todd Baert <[email protected]>

Author: 4 people

.github/workflows/release.yaml

@@ -40,7 +40,9 @@ jobs:
       - name: Set up Docker Buildx
         id: buildx
         uses: docker/setup-buildx-action@master
-
+      - name: Get current date
+        id: date
+        run: echo "::set-output name=date::$(date +'%Y-%m-%d')"
       - name: Build
         uses: docker/build-push-action@v2
         with:
@@ -51,6 +53,10 @@ jobs:
           push: true
           tags: ${{ steps.meta.outputs.tags }}
           labels: ${{ steps.meta.outputs.labels }}
+          build-args: | 
+            VERSION=${{ steps.meta.outputs.tags }}
+            COMMIT=${{ github.sha }}
+            DATE=${{ steps.date.outputs.date }}
   goreleaser:
     runs-on: ubuntu-latest
     steps:

Dockerfile

@@ -4,6 +4,9 @@ FROM --platform=$BUILDPLATFORM golang:1.18-alpine AS builder
 WORKDIR /workspace
 ARG TARGETOS
 ARG TARGETARCH
+ARG VERSION
+ARG COMMIT
+ARG DATE
 # Copy the Go Modules manifests
 COPY go.mod go.mod
 COPY go.sum go.sum
@@ -17,7 +20,7 @@ COPY cmd/ cmd/
 COPY pkg/ pkg/
 
 # Build
-RUN CGO_ENABLED=0 GOOS=${TARGETOS} GOARCH=${TARGETARCH} go build -a -o flagd main.go
+RUN CGO_ENABLED=0 GOOS=${TARGETOS} GOARCH=${TARGETARCH} go build -a -ldflags "-X main.version=${VERSION} -X main.commit=${COMMIT} -X main.date=${DATE}" -o flagd main.go
 
 # Use distroless as minimal base image to package the manager binary
 # Refer to https://github.com/GoogleContainerTools/distroless for more details

Makefile

@@ -1,17 +1,18 @@
 IMG ?= flagd:latest
 PHONY: .docker-build .build .run .mockgen
 PREFIX=/usr/local
+
 guard-%:
 	@ if [ "${${*}}" = "" ]; then \
         echo "Environment variable $* not set"; \
         exit 1; \
     fi
 docker-build:
-	docker buildx build --platform="linux/ppc64le,linux/s390x,linux/amd64,linux/arm64" -t ${IMG} .
+	docker buildx build --build-arg=VERSION="$$(git describe --tags --abbrev=0)" --build-arg=COMMIT="$$(git rev-parse --short HEAD)" --build-arg DATE="$$(date +%Y%m%d)" --platform="linux/ppc64le,linux/s390x,linux/amd64,linux/arm64" -t ${IMG} . --load
 docker-push:
-	docker buildx build --push --platform="linux/ppc64le,linux/s390x,linux/amd64,linux/arm64" -t ${IMG} .
+	docker buildx build --push --build-arg=VERSION="$$(git describe --tags --abbrev=0)" --build-arg=COMMIT="$$(git rev-parse --short HEAD)" --build-arg DATE="$$(date +%Y%m%d)" --platform="linux/ppc64le,linux/s390x,linux/amd64,linux/arm64" -t ${IMG} .
 build:
-	go build -o flagd
+	go build -ldflags "-X main.version=dev -X main.commit=$$(git rev-parse --short HEAD) -X main.date=$$(date +%Y%m%d)" -o flagd
 test:
 	go test -cover ./...
 run:

cmd/root.go

@@ -8,7 +8,12 @@ import (
 	"github.com/spf13/viper"
 )
 
-var cfgFile string
+var (
+	cfgFile string
+	Version string
+	Commit  string
+	Date    string
+)
 
 var rootCmd = &cobra.Command{
 	Use: "flagd",
@@ -22,7 +27,10 @@ var rootCmd = &cobra.Command{
 
 // Execute adds all child commands to the root command and sets flags appropriately.
 // This is called by main.main(). It only needs to happen once to the rootCmd.
-func Execute() {
+func Execute(version string, commit string, date string) {
+	Version = version
+	Commit = commit
+	Date = date
 	err := rootCmd.Execute()
 	if err != nil {
 		os.Exit(1)

cmd/version.go

@@ -0,0 +1,25 @@
+/*
+Copyright © 2022 NAME HERE <EMAIL ADDRESS>
+
+*/
+package cmd
+
+import (
+	"fmt"
+
+	"github.com/spf13/cobra"
+)
+
+// versionCmd represents the version command
+var versionCmd = &cobra.Command{
+	Use:   "version",
+	Short: "Print the version number of FlagD",
+	Long:  ``,
+	Run: func(cmd *cobra.Command, args []string) {
+		fmt.Printf("flagd %s (%s) built at %s\n", Version, Commit, Date)
+	},
+}
+
+func init() {
+	rootCmd.AddCommand(versionCmd)
+}

main.go

@@ -1,7 +1,15 @@
 package main
 
-import "github.com/open-feature/flagd/cmd"
+import (
+	"github.com/open-feature/flagd/cmd"
+)
+
+var (
+	version = "dev"
+	commit  = "HEAD"
+	date    = "unknown"
+)
 
 func main() {
-	cmd.Execute()
+	cmd.Execute(version, commit, date)
 }