Select binary within a github release archive when multiple present (#74)

* filter multiple bins by configured binary name

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

* update tools

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

* update linter

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

* update docs

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

* fix lint

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

* account for windows ext

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

* use filepath for path parsing

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

---------

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

Author: wagoodman

.binny.yaml

@@ -17,14 +17,14 @@ tools:
 
   - name: gh
     version:
-      want: v2.35.0
+      want: v2.67.0
     method: github-release
     with:
       repo: cli/cli
 
   - name: quill
     version:
-      want: v0.4.1
+      want: v0.5.1
     method: github-release
     with:
       repo: anchore/quill
@@ -45,21 +45,21 @@ tools:
 
   - name: glow
     version:
-      want: v1.5.1
+      want: v2.1.0
     method: github-release
     with:
       repo: charmbracelet/glow
 
   - name: goreleaser
     version:
-      want: v1.21.1
+      want: v2.7.0
     method: github-release
     with:
       repo: goreleaser/goreleaser
 
   - name: golangci-lint
     version:
-      want: v1.54.2
+      want: v1.64.6
     method: github-release
     with:
       repo: golangci/golangci-lint
@@ -73,14 +73,14 @@ tools:
 
   - name: task
     version:
-      want: v3.30.1
+      want: v3.41.0
     method: github-release
     with:
       repo: go-task/task
 
   - name: syft
     version:
-      want: v0.91.0
+      want: v1.20.0
     method: github-release
     with:
       repo: anchore/syft

.github/actions/bootstrap/action.yaml

@@ -4,7 +4,7 @@ inputs:
   go-version:
     description: "Go version to install"
     required: true
-    default: "1.21.x"
+    default: "1.24.x"
   cache-key-prefix:
     description: "Prefix all cache keys with this value"
     required: true

.golangci.yaml

@@ -1,7 +1,8 @@
 issues:
   max-same-issues: 25
+  uniq-by-line: false
 
-  # TODO: enable this when we have coverage on docstring comments
+# TODO: enable this when we have coverage on docstring comments
 #  # The list of ids of default excludes to include or disable.
 #  include:
 #    - EXC0002 # disable excluding of issues about comments from golint
@@ -12,10 +13,10 @@ linters:
   enable:
     - asciicheck
     - bodyclose
+    - copyloopvar
     - dogsled
     - dupl
     - errcheck
-    - exportloopref
     - funlen
     - gocognit
     - goconst
@@ -30,6 +31,7 @@ linters:
     - ineffassign
     - misspell
     - nakedret
+    - nolintlint
     - revive
     - staticcheck
     - stylecheck
@@ -49,10 +51,12 @@ linters-settings:
     # If lower than 0, disable the check.
     # Default: 40
     statements: 50
-output:
-  uniq-by-line: false
+  gosec:
+    excludes:
+      - G115
 run:
   timeout: 10m
+  tests: false
 
 # do not enable...
 #    - deadcode          # The owner seems to have abandoned the linter. Replaced by "unused".
@@ -72,7 +76,6 @@ run:
 #    - lll         # without a way to specify per-line exception cases, this is not usable
 #    - maligned    # this is an excellent linter, but tricky to optimize and we are not sensitive to memory layout optimizations
 #    - nestif
-#    - nolintlint   # as of go1.19 this conflicts with the behavior of gofmt, which is a deal-breaker (lint-fix will still fail when running lint)
 #    - prealloc     # following this rule isn't consistently a good idea, as it sometimes forces unnecessary allocations that result in less idiomatic code
 #    - rowserrcheck # not in a repo with sql, so this is not useful
 #    - scopelint    # deprecated

README.md

@@ -196,9 +196,10 @@ The `version.want` option allows a special entry:
 
 The `github-release` version method uses the GitHub Releases API to determine the latest release of a tool. It requires the following configuration options:
 
-| Option | Description                                                                                     |
-|--------|-------------------------------------------------------------------------------------------------|
-| `repo` | The GitHub repository to reference releases from. This should be in the format `<owner>/<repo>` |
+| Option   | Description                                                                                     |
+|----------|-------------------------------------------------------------------------------------------------|
+| `binary` | Binary to select if there are multiple within the release archive (defaults to the tool name)   |
+| `repo`   | The GitHub repository to reference releases from. This should be in the format `<owner>/<repo>` |
 
 The `version.want` option allows a special entry:
 - `latest`: don't pin to a version, use the latest available

Taskfile.yaml

@@ -59,20 +59,37 @@ tasks:
   tools:
     desc: Install all tools needed for CI and local development
     deps: [binny]
+    aliases:
+      - bootstrap
     generates:
-      - "{{ .TOOL_DIR }}/binny"
-      - "{{ .TOOL_DIR }}/goreleaser"
-      - "{{ .TOOL_DIR }}/chronicle"
-      - "{{ .TOOL_DIR }}/glow"
-      - "{{ .TOOL_DIR }}/golangci-lint"
-      - "{{ .TOOL_DIR }}/gosimports"
-      - "{{ .TOOL_DIR }}/bouncer"
-      - "{{ .TOOL_DIR }}/task"
+      - ".binny.yaml"
+      - "{{ .TOOL_DIR }}/*"
     status:
       - "{{ .TOOL_DIR }}/binny check -v"
     cmd: "{{ .TOOL_DIR }}/binny install -v"
     silent: true
 
+  update-tools:
+    desc: Update pinned versions of all tools to their latest available versions
+    deps: [binny]
+    generates:
+      - ".binny.yaml"
+      - "{{ .TOOL_DIR }}/*"
+    cmd: "{{ .TOOL_DIR }}/binny update -v"
+    silent: true
+
+  list-tools:
+    desc: List all tools needed for CI and local development
+    deps: [binny]
+    cmd: "{{ .TOOL_DIR }}/binny list"
+    silent: true
+
+  list-tool-updates:
+    desc: List all tools that are not up to date relative to the binny config
+    deps: [binny]
+    cmd: "{{ .TOOL_DIR }}/binny list --updates"
+    silent: true
+
 
   ## Static analysis tasks #################################
 
@@ -129,7 +146,7 @@ tasks:
           sh: "python ./scripts/list_units.py anchore binny"
 
       # unit test coverage threshold (in % coverage)
-      COVERAGE_THRESHOLD: '{{if eq OS "windows"}} 43 {{else}} 45 {{end}}'
+      COVERAGE_THRESHOLD: 35
     cmds:
       - cmd: "{{ .MAKEDIR_P }} {{ .TMP_DIR }}"
         silent: true

cmd/binny/cli/command/add_github_release.go

@@ -30,13 +30,13 @@ func AddGithubRelease(app clio.Application) *cobra.Command {
 		Use:   "github-release OWNER/REPO@VERSION",
 		Short: "Add a new tool configuration that sources binaries from GitHub releases",
 		Args:  cobra.ExactArgs(1),
-		PreRunE: func(cmd *cobra.Command, args []string) error {
+		PreRunE: func(_ *cobra.Command, args []string) error {
 			if !strings.Contains(args[0], "/") {
 				return fmt.Errorf("invalid 'owner/project@version' format: %q", args[0])
 			}
 			return nil
 		},
-		RunE: func(cmd *cobra.Command, args []string) error {
+		RunE: func(_ *cobra.Command, args []string) error {
 			return runGithubReleaseConfig(*cfg, args[0])
 		},
 	}, cfg)

cmd/binny/cli/command/add_go_install.go

@@ -35,13 +35,13 @@ func AddGoInstall(app clio.Application) *cobra.Command {
 		Use:   "go-install NAME@VERSION --module GOMODULE [--entrypoint PATH] [--ldflags FLAGS]",
 		Short: "Add a new tool configuration from 'go install ...' invocations",
 		Args:  cobra.ExactArgs(1),
-		PreRunE: func(cmd *cobra.Command, args []string) error {
+		PreRunE: func(_ *cobra.Command, _ []string) error {
 			if cfg.Install.GoInstall.Module == "" {
 				return fmt.Errorf("go-install configuration requires '--module' option")
 			}
 			return nil
 		},
-		RunE: func(cmd *cobra.Command, args []string) error {
+		RunE: func(_ *cobra.Command, args []string) error {
 			return runAddGoInstallConfig(*cfg, args[0])
 		},
 	}, cfg)

cmd/binny/cli/command/check.go

@@ -33,11 +33,11 @@ func Check(app clio.Application) *cobra.Command {
 		Use:   "check",
 		Short: "Verify tool are installed at the configured version",
 		Args:  cobra.ArbitraryArgs,
-		PreRunE: func(cmd *cobra.Command, args []string) error {
+		PreRunE: func(_ *cobra.Command, args []string) error {
 			names = args
 			return nil
 		},
-		RunE: func(cmd *cobra.Command, args []string) error {
+		RunE: func(_ *cobra.Command, _ []string) error {
 			return runCheck(*cfg, names)
 		},
 	}, cfg)

cmd/binny/cli/command/install.go

@@ -39,18 +39,17 @@ func Install(app clio.Application) *cobra.Command {
 		Use:   "install",
 		Short: "Install tools",
 		Args:  cobra.ArbitraryArgs,
-		PreRunE: func(cmd *cobra.Command, args []string) error {
+		PreRunE: func(_ *cobra.Command, args []string) error {
 			names = args
 			return nil
 		},
-		RunE: func(cmd *cobra.Command, args []string) error {
+		RunE: func(_ *cobra.Command, _ []string) error {
 			return runInstall(*cfg, names)
 		},
 	}, cfg)
 }
 
-// nolint: funlen
-func runInstall(cmdCfg InstallConfig, names []string) error {
+func runInstall(cmdCfg InstallConfig, names []string) error { //nolint: funlen
 	names, toolOpts := selectNamesAndConfigs(cmdCfg.Core, names)
 
 	if len(toolOpts) == 0 {
@@ -115,7 +114,7 @@ func runInstall(cmdCfg InstallConfig, names []string) error {
 	}
 
 	// note: we can ignore the error here because we are tracking the error through the multierror object
-	g.Wait() // nolint: errcheck
+	g.Wait() //nolint: errcheck
 
 	alreadyInstalled = len(alreadyInstalledTools) > 0 && len(alreadyInstalledTools) == len(toolOpts)
 

cmd/binny/cli/command/list.go

@@ -44,14 +44,14 @@ func List(app clio.Application) *cobra.Command {
 			"ls",
 		},
 		Args: cobra.ArbitraryArgs,
-		PreRunE: func(cmd *cobra.Command, args []string) error {
+		PreRunE: func(_ *cobra.Command, args []string) error {
 			if cfg.Format.JQCommand != "" && cfg.Format.Output != "json" {
 				return fmt.Errorf("--jq can only be used when --output format is 'json'")
 			}
 			cfg.IncludeFilter = args
 			return nil
 		},
-		RunE: func(cmd *cobra.Command, args []string) error {
+		RunE: func(_ *cobra.Command, _ []string) error {
 			return runList(*cfg)
 		},
 	}, cfg)