Refine CLI format and output options + repo rename (#6)

Author: wagoodman

.github/workflows/validations.yaml

@@ -133,39 +133,39 @@ jobs:
     runs-on: ubuntu-20.04
     steps:
       - uses: actions/checkout@v2
-
-      - uses: actions/download-artifact@v2
-        with:
-          name: artifacts
-          path: snapshot
-
-      - name: Build key for image cache
-        run: make install-fingerprint
-
-      - name: Restore install.sh test image cache
-        id: install-test-image-cache
-        uses: actions/cache@v2.1.3
-        with:
-          path: ${{ github.workspace }}/test/install/cache
-          key: ${{ runner.os }}-install-test-image-cache-${{ hashFiles('test/install/cache.fingerprint') }}
-
-      - name: Restore tool cache
-        id: tool-cache
-        uses: actions/cache@v2.1.3
-        with:
-          path: ${{ github.workspace }}/.tmp
-          key: ${{ runner.os }}-tool-${{ hashFiles('Makefile') }}
-
-      - name: Load test image cache
-        if: steps.install-test-image-cache.outputs.cache-hit == 'true'
-        run: make install-test-cache-load
-
-      - name: Run install.sh tests (Linux)
-        run: make install-test
-
-      - name: (cache-miss) Create test image cache
-        if: steps.install-test-image-cache.outputs.cache-hit != 'true'
-        run: make install-test-cache-save
+# TODO: this can be re-enabled after the first release in the docker org
+#      - uses: actions/download-artifact@v2
+#        with:
+#          name: artifacts
+#          path: snapshot
+#
+#      - name: Build key for image cache
+#        run: make install-fingerprint
+#
+#      - name: Restore install.sh test image cache
+#        id: install-test-image-cache
+#        uses: actions/cache@v2.1.3
+#        with:
+#          path: ${{ github.workspace }}/test/install/cache
+#          key: ${{ runner.os }}-install-test-image-cache-${{ hashFiles('test/install/cache.fingerprint') }}
+#
+#      - name: Restore tool cache
+#        id: tool-cache
+#        uses: actions/cache@v2.1.3
+#        with:
+#          path: ${{ github.workspace }}/.tmp
+#          key: ${{ runner.os }}-tool-${{ hashFiles('Makefile') }}
+#
+#      - name: Load test image cache
+#        if: steps.install-test-image-cache.outputs.cache-hit == 'true'
+#        run: make install-test-cache-load
+#
+#      - name: Run install.sh tests (Linux)
+#        run: make install-test
+#
+#      - name: (cache-miss) Create test image cache
+#        if: steps.install-test-image-cache.outputs.cache-hit != 'true'
+#        run: make install-test-cache-save
 
   Acceptance-Mac:
     # Note: changing this job name requires making the same update in the .github/workflows/release.yaml pipeline

.goreleaser.yaml

@@ -19,10 +19,9 @@ builds:
       -w
       -s
       -extldflags '-static'
-      -X github.com/anchore/docker-sbom-cli-plugin/internal/version.version={{.Version}}
-      -X github.com/anchore/docker-sbom-cli-plugin/internal/version.gitCommit={{.Commit}}
-      -X github.com/anchore/docker-sbom-cli-plugin/internal/version.buildDate={{.Date}}
-      -X github.com/anchore/docker-sbom-cli-plugin/internal/version.gitDescription={{.Summary}}
+      -X github.com/docker/sbom-cli-plugin/internal/version.version={{.Version}}
+      -X github.com/docker/sbom-cli-plugin/internal/version.gitCommit={{.Commit}}
+      -X github.com/docker/sbom-cli-plugin/internal/version.gitDescription={{.Summary}}
 
 archives:
   - format: tar.gz

Makefile

@@ -1,5 +1,5 @@
 BIN = docker-sbom
-REPO = docker-sbom-cli-plugin
+REPO = sbom-cli-plugin
 
 TEMP_DIR = ./.tmp
 DIST_DIR=./dist
@@ -119,7 +119,7 @@ check-go-mod-tidy:
 .PHONY: unit
 unit: $(RESULTS_DIR)  ## Run unit tests
 	$(call title,Running unit tests)
-	go test  -coverprofile $(COVER_REPORT) $(shell go list ./... | grep -v anchore/docker-sbom-cli-plugin/test)
+	go test  -coverprofile $(COVER_REPORT) $(shell go list ./... | grep -v docker/sbom-cli-plugin/test)
 	@go tool cover -func $(COVER_REPORT) | grep total |  awk '{print substr($$3, 1, length($$3)-1)}' > $(COVER_TOTAL)
 	@echo "Coverage: $$(cat $(COVER_TOTAL))"
 

README.md

@@ -8,7 +8,7 @@ Plugin for Docker CLI to support SBOM creation using Syft.
 
 ```
 # install the docker-sbom plugin
-curl -sSfL https://raw.githubusercontent.com/anchore/docker-sbom-cli-plugin/main/install.sh | sh -s --
+curl -sSfL https://raw.githubusercontent.com/docker/sbom-cli-plugin/main/install.sh | sh -s --
 
 # use the sbom plugin
 docker sbom <my-image>

cmd/cmd.go

@@ -8,17 +8,17 @@ import (
 
 	"github.com/docker/cli/cli-plugins/manager"
 	"github.com/docker/cli/cli-plugins/plugin"
+	"github.com/docker/sbom-cli-plugin/internal"
+	"github.com/docker/sbom-cli-plugin/internal/bus"
+	"github.com/docker/sbom-cli-plugin/internal/config"
+	"github.com/docker/sbom-cli-plugin/internal/log"
+	"github.com/docker/sbom-cli-plugin/internal/logger"
+	"github.com/docker/sbom-cli-plugin/internal/version"
 	"github.com/gookit/color"
 	"github.com/spf13/cobra"
 	"github.com/spf13/viper"
 	"github.com/wagoodman/go-partybus"
 
-	"github.com/anchore/docker-sbom-cli-plugin/internal"
-	"github.com/anchore/docker-sbom-cli-plugin/internal/bus"
-	"github.com/anchore/docker-sbom-cli-plugin/internal/config"
-	"github.com/anchore/docker-sbom-cli-plugin/internal/log"
-	"github.com/anchore/docker-sbom-cli-plugin/internal/logger"
-	"github.com/anchore/docker-sbom-cli-plugin/internal/version"
 	"github.com/anchore/stereoscope"
 	"github.com/anchore/syft/syft"
 )
@@ -43,15 +43,17 @@ func Execute() {
 	plugin.Run(
 		cmd,
 		manager.Metadata{
-			SchemaVersion: internal.SchemaVersion,
-			Vendor:        "Anchore Inc.",
-			Version:       version.FromBuild().Version,
+			SchemaVersion:    internal.SchemaVersion,
+			Vendor:           "Anchore Inc.",
+			Version:          version.FromBuild().Version,
+			ShortDescription: shortDescription,
+			URL:              "https://github.com/docker/sbom-cli-plugin",
 		},
 	)
 }
 
 func initAppConfig() {
-	cfg, err := config.LoadApplicationConfig(viper.GetViper(), cliOnlyOpts)
+	cfg, err := config.LoadApplicationConfig(viper.GetViper())
 	if err != nil {
 		fmt.Printf("failed to load application config: \n\t%+v\n", err)
 		os.Exit(1)
@@ -62,7 +64,7 @@ func initAppConfig() {
 
 func initLogging() {
 	cfg := logger.LogrusConfig{
-		EnableConsole: (appConfig.Log.FileLocation == "" || appConfig.CliOptions.Verbosity > 0) && !appConfig.Quiet,
+		EnableConsole: (appConfig.Log.FileLocation == "" || appConfig.Debug) && !appConfig.Quiet,
 		EnableFile:    appConfig.Log.FileLocation != "",
 		Level:         appConfig.Log.LevelOpt,
 		Structured:    appConfig.Log.Structured,

cmd/event_loop.go

@@ -5,11 +5,10 @@ import (
 	"fmt"
 	"os"
 
+	"github.com/docker/sbom-cli-plugin/internal/log"
+	"github.com/docker/sbom-cli-plugin/internal/ui"
 	"github.com/hashicorp/go-multierror"
 	"github.com/wagoodman/go-partybus"
-
-	"github.com/anchore/docker-sbom-cli-plugin/internal/log"
-	"github.com/anchore/docker-sbom-cli-plugin/internal/ui"
 )
 
 // eventLoop listens to worker errors (from execution path), worker events (from a partybus subscription), and

cmd/event_loop_test.go

@@ -7,11 +7,11 @@ import (
 	"testing"
 	"time"
 
+	"github.com/docker/sbom-cli-plugin/internal/ui"
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/mock"
 	"github.com/wagoodman/go-partybus"
 
-	"github.com/anchore/docker-sbom-cli-plugin/internal/ui"
 	"github.com/anchore/syft/syft/event"
 )