feat: added parameter to enable/disable deployment tracking

Author: demeyerthom

.github/workflows/pull-request.yaml

@@ -19,11 +19,6 @@ jobs:
           go-version: ${{ matrix.go-version }}
         id: go
 
-      - name: Install Task
-        uses: arduino/setup-task@v1
-        with:
-          repo-token: ${{ secrets.GITHUB_TOKEN }}
-
       - name: Set up Go modules cache
         uses: actions/cache@v3
         env:
@@ -47,7 +42,7 @@ jobs:
           args: --issues-exit-code=0
 
       - name: Run tests
-        run: task cover
+        run: go test -race -coverprofile=coverage.out -covermode=atomic ./...
 
       - name: Build binary
         uses: goreleaser/goreleaser-action@v3

Taskfile.yaml

@@ -5,10 +5,9 @@ tasks:
     cmd: golangci-lint run
 
   build:
+    env:
+      GORELEASER_CURRENT_TAG: v0.0.0
     cmd: goreleaser build --snapshot --single-target --rm-dist --clean
 
   test:
     cmd: go test -race ./...
-
-  cover:
-    cmd: go test -race -coverprofile=coverage.out -covermode=atomic ./...

internal/config.go

@@ -2,25 +2,26 @@ package internal
 
 // BaseConfig is the base honeycomb config.
 type BaseConfig struct {
-	ApiKey  string `mapstructure:"api_key"`
-	DataSet string `mapstructure:"dataset"`
-	Type    string `mapstructure:"type"`
-	Url     string `mapstructure:"url"`
+	ApiKey           string `mapstructure:"api_key"`
+	DataSet          string `mapstructure:"dataset"`
+	Type             string `mapstructure:"type"`
+	Url              string `mapstructure:"url"`
+	TrackDeployments bool   `mapstructure:"track_deployments"`
 }
 
 type GlobalConfig struct {
 	BaseConfig `mapstructure:",squash"`
 }
 
 type SiteConfig struct {
-	BaseConfig `mapstructure:",squash"`
-	Components map[string]*SiteComponentConfig `mapstructure:"-"`
+	BaseConfig     `mapstructure:",squash"`
+	SiteComponents map[string]*SiteComponentConfig `mapstructure:"-"`
 }
 
 func (c *SiteConfig) extendGlobalConfig(g *GlobalConfig) *SiteConfig {
 	cfg := &SiteConfig{
-		BaseConfig: g.BaseConfig,
-		Components: c.Components,
+		BaseConfig:     g.BaseConfig,
+		SiteComponents: c.SiteComponents,
 	}
 
 	if c.ApiKey != "" {
@@ -36,6 +37,10 @@ func (c *SiteConfig) extendGlobalConfig(g *GlobalConfig) *SiteConfig {
 		cfg.Url = c.Url
 	}
 
+	if c.TrackDeployments != false {
+		cfg.TrackDeployments = c.TrackDeployments
+	}
+
 	return cfg
 }
 
@@ -49,9 +54,6 @@ func (c *SiteComponentConfig) extendSiteConfig(s *SiteConfig) *SiteComponentConf
 		BaseConfig: s.BaseConfig,
 	}
 
-	if c.ApiKey != "" {
-		cfg.ApiKey = c.ApiKey
-	}
 	if c.DataSet != "" {
 		cfg.DataSet = c.DataSet
 	}
@@ -62,6 +64,10 @@ func (c *SiteComponentConfig) extendSiteConfig(s *SiteConfig) *SiteComponentConf
 		cfg.Url = c.Url
 	}
 
+	if c.TrackDeployments != false {
+		cfg.TrackDeployments = c.TrackDeployments
+	}
+
 	return cfg
 }
 

internal/plugin.go

@@ -58,7 +58,7 @@ func (p *HoneycombPlugin) getSiteComponentConfig(site, name string) *SiteCompone
 		return nil
 	}
 
-	cfg, ok := siteCfg.Components[name]
+	cfg, ok := siteCfg.SiteComponents[name]
 	if !ok {
 		cfg = &SiteComponentConfig{}
 	}
@@ -100,7 +100,7 @@ func (p *HoneycombPlugin) SetGlobalConfig(data map[string]any) error {
 
 func (p *HoneycombPlugin) SetSiteConfig(site string, data map[string]any) error {
 	cfg := SiteConfig{
-		Components: map[string]*SiteComponentConfig{},
+		SiteComponents: map[string]*SiteComponentConfig{},
 	}
 	if err := mapstructure.Decode(data, &cfg); err != nil {
 		return err
@@ -118,11 +118,11 @@ func (p *HoneycombPlugin) SetSiteComponentConfig(site string, component string,
 	siteCfg, ok := p.siteConfigs[site]
 	if !ok {
 		siteCfg = &SiteConfig{
-			Components: map[string]*SiteComponentConfig{},
+			SiteComponents: map[string]*SiteComponentConfig{},
 		}
 		p.siteConfigs[site] = siteCfg
 	}
-	siteCfg.Components[component] = &cfg
+	siteCfg.SiteComponents[component] = &cfg
 
 	return nil
 }

internal/schemas/global-config.json

@@ -13,6 +13,11 @@
     },
     "url": {
       "type": "string"
+    },
+    "track_deployments": {
+      "type": "boolean",
+      "description": "Whether to track release deployments in Honeycomb.",
+      "default": false
     }
   }
 }

internal/schemas/site-component-config.json

@@ -13,6 +13,11 @@
     },
     "url": {
       "type": "string"
+    },
+    "track_deployments": {
+      "type": "boolean",
+      "description": "Whether to track release deployments in Honeycomb.",
+      "default": false
     }
   }
 }

internal/schemas/site-config.json

@@ -2,9 +2,6 @@
   "type": "object",
   "description": "Site Honeycomb configuration.",
   "properties": {
-    "api_key": {
-      "type": "string"
-    },
     "dataset": {
       "type": "string"
     },
@@ -13,6 +10,11 @@
     },
     "url": {
       "type": "string"
+    },
+    "track_deployments": {
+      "type": "boolean",
+      "description": "Whether to track release deployments in Honeycomb.",
+      "default": false
     }
   }
 }

internal/templates/resources.tmpl

@@ -1,12 +1,14 @@
-resource "honeycombio_marker" "{{ .ComponentName }}" {
-dataset = "{{ .Config.DataSet }}"
-message = "{{ .Version }}"
-{{ if .Config.Type }}
-    type = "{{ .Config.Type }}"
-{{ end }}
-{{ if .Config.Url }}
-    url = "{{ .Config.Url }}"
-{{ end }}
+{{ if .Config.TrackDeployments }}
+    resource "honeycombio_marker" "{{ .ComponentName }}" {
+    dataset = "{{ .Config.DataSet }}"
+    message = "{{ .Version }}"
+    {{ if .Config.Type }}
+        type = "{{ .Config.Type }}"
+    {{ end }}
+    {{ if .Config.Url }}
+        url = "{{ .Config.Url }}"
+    {{ end }}
 
-depends_on   = [module.{{ .ComponentName }}]
-}
+    depends_on   = [module.{{ .ComponentName }}]
+    }
+{{ end}}