chore: Add version (#137)

- add version and tidy up the Makefile
- update the goreleaser to remove the deprecated stuff
- update the docker file so it actually works

Author: owenrumney

.golangci.yml

@@ -1,6 +1,6 @@
 run:
   timeout: 3m
-  go: 1.20
+  go: 1.23.4
   modules-download-mode: vendor
 
 linters:
@@ -26,8 +26,6 @@ linters:
     - unused
     - unconvert
     - unparam
-    - vet
-    - vetshadow
     - wastedassign
 
 linters-settings:

.goreleaser.yml

@@ -9,7 +9,7 @@ builds:
     main: ./cmd/squealer
     binary: squealer
     ldflags:
-    - "-X github.com/owenrumney/squealer/version.Version={{.Version}} -s -w -extldflags '-fno-PIC -static'"
+    - "-X github.com/owenrumney/squealer/pkg/version.Version={{.Version}} -s -w -extldflags '-fno-PIC -static'"
     env:
       - CGO_ENABLED=0
       - GOFLAGS=-mod=vendor
@@ -27,7 +27,7 @@ checksum:
   name_template: '{{ .ProjectName }}_checksums.txt'
 
 snapshot:
-  name_template: "{{ .Tag }}-next"
+  version_template: "{{ .Tag }}-next"
 
 changelog:
   sort: asc
@@ -38,7 +38,7 @@ changelog:
 
 archives:
   -
-    format: binary
+    formats: [ binary ]
     name_template: "{{ .Binary}}.{{ .Os }}.{{ .Arch }}"
 
 release:

Dockerfile

@@ -1,15 +1,10 @@
 FROM alpine:3.21.2
 
-# use a non-privileged user
-USER nobody
+# Set the working directory
+WORKDIR /usr/bin
 
-# work somewhere where we can write
+# Copy the binary to the working directory
 COPY squealer /usr/bin/squealer
 
-# set the default entrypoint -- when this container is run, use this command
-ENTRYPOINT [ "squealer" ]
-
-# as we specified an entrypoint, this is appended as an argument (i.e., `sqealer --help`)
-CMD [ "--help" ]
-
-
+# Set the default entrypoint
+ENTRYPOINT [ "squealer" ]

Makefile

@@ -10,13 +10,10 @@ build: test
 test:
 	go test -v -covermode=atomic -coverpkg ./... -coverprofile coverage.txt ./...
 
-.PHONY: push-image
-push-image:
-	./scripts/publish-image.sh
 
 .PHONY: image
 image:
-	docker build --build-arg squealer_version=$(TRAVIS_TAG) -t $(IMAGE) .
+	docker build --build-arg squealer_version=development -t $(IMAGE) .
 
 .PHONY: lint
 quality:

internal/app/squealer/cmd/flags.go

@@ -13,6 +13,7 @@ var (
 	toHash         string
 	commitListFile string
 	format         string
+	showVersion    bool
 )
 
 func configureFlags(command *cobra.Command) {
@@ -21,6 +22,7 @@ func configureFlags(command *cobra.Command) {
 	command.PersistentFlags().BoolVar(&noGit, "no-git", noGit, "Scan as a directory rather than a git history.")
 	command.PersistentFlags().BoolVar(&debug, "debug", debug, "Include debug output.")
 	command.PersistentFlags().BoolVar(&everything, "everything", everything, "Scan all commits.... everywhere.")
+	command.PersistentFlags().BoolVar(&showVersion, "version", showVersion, "Show the version of the application.")
 	command.PersistentFlags().StringVar(&configFilePath, "config-file", configFilePath, "Path to the config file with the rules.")
 	command.PersistentFlags().StringVar(&fromHash, "from-hash", fromHash, "The hash to work back to from the starting hash.")
 	command.PersistentFlags().StringVar(&toHash, "to-hash", toHash, "The most recent hash to start with.")

internal/app/squealer/cmd/root.go

@@ -2,10 +2,12 @@ package cmd
 
 import (
 	"fmt"
+
 	"math"
 	"os"
 
 	"github.com/owenrumney/squealer/pkg/squealer"
+	"github.com/owenrumney/squealer/pkg/version"
 
 	log "github.com/sirupsen/logrus"
 	"github.com/spf13/cobra"
@@ -26,9 +28,16 @@ func Root() *cobra.Command {
 		Use:   "squealer",
 		Short: "Search for secrets and squeal about them",
 		Long:  `Telling tales on your secret leaking`,
-		RunE:  squeal,
+		PreRun: func(cmd *cobra.Command, args []string) {
+			if showVersion {
+				fmt.Println(version.Version)
+				os.Exit(0)
+			}
+		},
+		RunE: squeal,
 	}
 	configureFlags(rootCommand)
+
 	return rootCommand
 }
 

internal/pkg/scan/scanner.go

@@ -40,10 +40,10 @@ type Scanner interface {
 
 func NewScanner(sc *ScannerConfig) (Scanner, error) {
 	if sc.NoGit || notGit(sc.Basepath) {
-		log.Infof("Using a directory scanner to process %s\n", sc.Basepath)
+		log.Infof("Using a directory scanner to process %s", sc.Basepath)
 		return newDirectoryScanner(sc)
 	}
-	log.Infof("Using a git scanner to process %s\n", sc.Basepath)
+	log.Infof("Using a git scanner to process %s", sc.Basepath)
 	return newGitScanner(sc)
 }
 

pkg/version/version.go

@@ -0,0 +1,3 @@
+package version
+
+var Version = "dev"