Add update checker feature (#123)

* Add update chcker feature

* Add option to disable update check

Author: rxbn

CHANGELOG.md

@@ -1,5 +1,17 @@
 # Changelog
 
+## [v5.5.0](https://github.com/containeroo/SyncFlaer/tree/v5.5.0) (2022-05-02)
+
+[All Commits](https://github.com/containeroo/SyncFlaer/compare/v5.4.2...v5.5.0)
+
+**New features:**
+
+- Added update checker. Can be disabled by setting `skipUpdateCheck` to `true`.
+
+**Dependencies:**
+
+- Bump several dependencies
+
 ## [v5.4.2](https://github.com/containeroo/SyncFlaer/tree/v5.4.2) (2022-03-22)
 
 [All Commits](https://github.com/containeroo/SyncFlaer/compare/v5.4.1...v5.4.2)

README.md

@@ -2,10 +2,6 @@
 
 Synchronize Traefik host rules and/or Kubernetes Ingresses with Cloudflare®.
 
-![Docker Image Version (latest semver)](https://img.shields.io/docker/v/containeroo/syncflaer?sort=semver)
-![Docker Pulls](https://img.shields.io/docker/pulls/containeroo/syncflaer)
-![GitHub go.mod Go version](https://img.shields.io/github/go-mod/go-version/containeroo/syncflaer)
-
 ## Why?
 
 - Dynamically create, update or delete Cloudflare® DNS records based on Traefik http rules and/or Kubernetes Ingresses (apiVersion: networking.k8s.io/v1)
@@ -163,6 +159,7 @@ If not specified, the following defaults apply:
 
 | Name                           | Default Value                                                                                                                            |
 |--------------------------------|------------------------------------------------------------------------------------------------------------------------------------------|
+| `skipUpdateCheck`              | `false`                                                                                                                                  |
 | `ipProviders`                  | `["https://ifconfig.me/ip", "https://ipecho.net/plain", "https://myip.is/ip", "https://checkip.amazonaws.com", "https://api.ipify.org"]` |
 | `kubernetes.enabled`           | `false`                                                                                                                                  |
 | `managedRootRecord`            | `true`                                                                                                                                   |

cmd/syncflaer/main.go

@@ -1,9 +1,11 @@
 package main
 
 import (
+	"context"
 	"fmt"
 	"github.com/cloudflare/cloudflare-go"
 	"github.com/containeroo/syncflaer/internal/kube"
+	"github.com/google/go-github/v44/github"
 	"os"
 	"strconv"
 
@@ -12,7 +14,21 @@ import (
 	log "github.com/sirupsen/logrus"
 )
 
-const version string = "5.4.2"
+const version string = "5.5.0"
+
+var latestVersion string
+
+func checkVersionUpdate() {
+	githubClient := github.NewClient(nil)
+	latestRelease, _, err := githubClient.Repositories.GetLatestRelease(context.Background(), "containeroo", "syncflaer")
+	if err != nil {
+		log.Errorf("Failed to get latest release: %s", err)
+		return
+	}
+	if latestRelease.GetTagName() != fmt.Sprintf("v%s", version) {
+		latestVersion = latestRelease.GetTagName()
+	}
+}
 
 func main() {
 	log.SetOutput(os.Stdout)
@@ -40,6 +56,10 @@ func main() {
 
 	config := internal.GetConfig(configFilePath)
 
+	if !*config.SkipUpdateCheck {
+		go checkVersionUpdate()
+	}
+
 	cf := internal.SetupCloudflareClient(&config.Cloudflare.APIToken)
 	zoneIDs := internal.CreateCloudflareZoneMap(&config.Cloudflare.ZoneNames, cf)
 	currentIP := internal.GetCurrentIP(&config.IPProviders)
@@ -109,4 +129,8 @@ func main() {
 	}
 
 	slackHandler.SendSlackMessage(config)
+
+	if latestVersion != "" {
+		log.Infof("New version available: %s, download here: https://github.com/containeroo/syncflaer/releases/tag/%s", latestVersion, latestVersion)
+	}
 }

configs/config.yml

@@ -1,4 +1,7 @@
 ---
+# enable or disable update check
+skipUpdateCheck: false
+
 # a list of services that return the public IP
 ipProviders:
   - https://ifconfig.me/ip

go.mod

@@ -3,6 +3,7 @@ module github.com/containeroo/syncflaer
 go 1.18
 
 require (
+	github.com/google/go-github/v44 v44.0.0
 	github.com/cloudflare/cloudflare-go v0.38.0
 	github.com/sirupsen/logrus v1.8.1
 	github.com/slack-go/slack v0.10.3

go.sum

@@ -667,6 +667,8 @@ github.com/google/go-containerregistry v0.0.0-20191015185424-71da34e4d9b3/go.mod
 github.com/google/go-github v17.0.0+incompatible/go.mod h1:zLgOLi98H3fifZn+44m+umXrS52loVEgC2AApnigrVQ=
 github.com/google/go-github/v28 v28.1.1/go.mod h1:bsqJWQX05omyWVmc00nEUql9mhQyv38lDZ8kPZcQVoM=
 github.com/google/go-github/v32 v32.1.0/go.mod h1:rIEpZD9CTDQwDK9GDrtMTycQNA4JU3qBsCizh3q2WCI=
+github.com/google/go-github/v44 v44.0.0 h1:1Lfk2mhM7pTWqwGC6Ft16S3c2LBw8DLcw9TOhYoQ9zE=
+github.com/google/go-github/v44 v44.0.0/go.mod h1:CqZYQRxOcb81M+ufZB7duWNS0lFfas/r7cEAKpLBYww=
 github.com/google/go-querystring v0.0.0-20170111101155-53e6ce116135/go.mod h1:odCYkC5MyYFN7vkCjXpyrEuKhc/BUO6wN/zVPAxq5ck=
 github.com/google/go-querystring v1.0.0/go.mod h1:odCYkC5MyYFN7vkCjXpyrEuKhc/BUO6wN/zVPAxq5ck=
 github.com/google/go-querystring v1.1.0 h1:AnCroh3fv4ZBgVIf1Iwtovgjaw/GiKJo8M8yD/fhyJ8=

internal/config.go

@@ -12,8 +12,9 @@ import (
 )
 
 type Configuration struct {
-	IPProviders   []string `yaml:"ipProviders"`
-	Notifications struct {
+	SkipUpdateCheck *bool    `yaml:"skipUpdateCheck"`
+	IPProviders     []string `yaml:"ipProviders"`
+	Notifications   struct {
 		Slack struct {
 			WebhookURL string `yaml:"webhookURL"`
 			Username   string `yaml:"username"`
@@ -107,6 +108,7 @@ func GetConfig(configFilePath string) *Configuration {
 
 	// Set default values
 	trueVar := true
+	falseVar := false
 	if config.ManagedRootRecord == nil {
 		config.ManagedRootRecord = &trueVar
 		log.Debugf("ManagedRootRecord is not set, defaulting to %t", *config.ManagedRootRecord)
@@ -138,6 +140,11 @@ func GetConfig(configFilePath string) *Configuration {
 		log.Debugf("IP providers is empty, defaulting to %s", strings.Join(config.IPProviders, ", "))
 	}
 
+	if config.SkipUpdateCheck == nil {
+		config.SkipUpdateCheck = &falseVar
+		log.Debugf("SkipUpdateCheck is not set, defaulting to %t", *config.SkipUpdateCheck)
+	}
+
 	if config.Notifications.Slack.Username == "" {
 		config.Notifications.Slack.Username = "SyncFlaer"
 		log.Debugf("Slack username is empty, defaulting to %s", config.Notifications.Slack.Username)