Merge pull request #232 from nao1215/nchika/v1.0.0

Release v1.0.0

Author: nao1215

.github/workflows/unit_test.yml

@@ -32,6 +32,5 @@ jobs:
           go-version: ${{ matrix.go }}
 
       - name: Run tests with race detector (Linux only)
-        if: matrix.os == 'ubuntu-latest'
         run: go test -race ./...
 

CHANGELOG.md

@@ -1,3 +1,55 @@
+## [v1.0.0](https://github.com/nao1215/gup/compare/v0.28.3...v1.0.0) (2026-02-15)
+
+### ⚠ BREAKING CHANGES
+
+* Config format changed from plain-text `gup.conf` (`<name> = <import-path>`) to JSON `gup.json` with versioned schema
+* `gup import` now installs the exact version recorded in `gup.json`
+* `gup import` flag changed from `--input` to `--file`
+* `gup export` flag changed from `--output` to `--file`
+
+### Features
+
+* Store update channels (`latest` / `main` / `master`) in `gup.json`
+* Auto-adapt to module path changes (detect and follow import path renames)
+* Add config path resolution (`$XDG_CONFIG_HOME/gup/gup.json` first, then `./gup.json`)
+* Add `--file` option to both import and export
+* Always include version in bug-report template
+
+### Fixes
+
+* Persist dry-run temp path for proper cleanup and cancel workers on interrupt signals
+* Validate binary names in `removeOldBinaryIfRenamed` to prevent path traversal
+* Block path traversal in remove targets
+* Warn instead of failing when `gup.json` is corrupt during update
+* Surface `gup.json` parse errors during update
+* Normalize binary names in `--main`/`--master`/`--latest` flag resolution for Windows
+* Remove stale config entries when binary is renamed during update
+* Return original importPath when prefix does not match in `replaceImportPathPrefix`
+* Trim whitespace in `--exclude` package names
+* Require explicit `--install` for completion file writes
+* Validate go command availability in import
+* Exit with status 1 when command execution fails
+* Version coloring: yellow=outdated, green=up-to-date
+* Reject malformed `gup.conf` lines early (legacy format migration)
+* Normalize devel version to latest during import
+
+### Performance
+
+* Use a fixed worker-pool implementation for package processing
+* Deduplicate `GetLatestVer` calls and parallelize binary info collection
+* Filter binary completions by typed prefix
+
+### Refactoring
+
+* Replace `golang.org/x/exp/slices` with standard `slices` package
+* Share config file writing logic across commands
+* Remove unused update wrapper function and unused first argument from `shouldPersistChannels`
+
+### Tests
+
+* Add tests to increase coverage from 79.6% to 88.7%
+* Stub update operations in root command tests
+
 ## [v0.28.3](https://github.com/nao1215/gup/compare/v0.28.2...v0.28.3) (2026-02-15)
 
 * Fix bug fixes and CI improvements [#230](https://github.com/nao1215/gup/pull/230) ([nao1215](https://github.com/nao1215))

README.md

@@ -4,7 +4,6 @@
 [![Mentioned in Awesome Go](https://awesome.re/mentioned-badge.svg)](https://github.com/avelino/awesome-go)
 [![reviewdog](https://github.com/nao1215/gup/actions/workflows/reviewdog.yml/badge.svg)](https://github.com/nao1215/gup/actions/workflows/reviewdog.yml)
 ![Coverage](https://raw.githubusercontent.com/nao1215/octocovs-central-repo/main/badges/nao1215/gup/coverage.svg)
-[![gosec](https://github.com/nao1215/gup/actions/workflows/security.yml/badge.svg)](https://github.com/nao1215/gup/actions/workflows/security.yml)
 [![Go Reference](https://pkg.go.dev/badge/github.com/nao1215/gup.svg)](https://pkg.go.dev/github.com/nao1215/gup)
 [![Go Report Card](https://goreportcard.com/badge/github.com/nao1215/gup)](https://goreportcard.com/report/github.com/nao1215/gup)
 ![GitHub](https://img.shields.io/github/license/nao1215/gup)
@@ -19,6 +18,11 @@
 
 If you are using oh-my-zsh, then gup has an alias set up. The alias is `gup - git pull --rebase`. Therefore, please make sure that the oh-my-zsh alias is disabled (e.g. $ \gup update).
 
+## Breaking change (v1.0.0)
+- The config file format changed from `gup.conf` to `gup.json`.
+- `gup.conf` is no longer read by `gup import`.
+- The update channel (`latest` / `main` / `master`) is stored per package in `gup.json`.
+
 
 ## Supported OS (unit testing with GitHub Actions)
 - Linux
@@ -80,10 +84,15 @@ Also works in combination with --dry-run
 $ gup update --exclude=gopls,golangci-lint    //--exclude or -e, this example will exclude 'gopls' and 'golangci-lint'
 ```
 
-### Update binaries with @main or @master
-If you want to update binaries with @master or @main, you can specify the -m or --master option.
+### Update binaries with @main, @master, or @latest
+If you want to control update source per binary, use the following options:
+- `--main` (`-m`): update by `@main` (fallback to `@master`)
+- `--master`: update by `@master`
+- `--latest`: update by `@latest`
+
+The selected channel is saved to `gup.json` and reused by future `gup update` runs.
 ```shell
-$ gup update --main=gup,lazygit,sqly
+$ gup update --main=gup,lazygit --master=sqly --latest=air
 ```
 
 ### List up command name with package path and version under $GOPATH/bin
@@ -133,27 +142,54 @@ If you want to update binaries, the following command.
            $ gup update mimixbox
 ```
 ### Export／Import subcommand
-You use the export／import subcommand if you want to install the same golang binaries across multiple systems. By default, export-subcommand exports the file to $XDG_CONFIG_HOME/gup/gup.conf. If you want to know [XDG Base Directory Specification](https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html), see this link. After you have placed gup.conf in the same path hierarchy on another system, you execute import-subcommand. gup start the installation
-according to the contents of gup.conf.
+Use export/import when you want to install the same Go binaries across multiple systems.
+`gup.json` stores import path, binary version, and update channel (`latest` / `main` / `master`).
+`import` installs the exact version written in the file.
+
+```json
+{
+  "schema_version": 1,
+  "packages": [
+    {
+      "name": "gal",
+      "import_path": "github.com/nao1215/gal/cmd/gal",
+      "version": "v1.1.1",
+      "channel": "latest"
+    },
+    {
+      "name": "posixer",
+      "import_path": "github.com/nao1215/posixer",
+      "version": "v0.1.0",
+      "channel": "main"
+    }
+  ]
+}
+```
+
+By default:
+- `gup export` writes to `$XDG_CONFIG_HOME/gup/gup.json`
+- `gup import` auto-detects config path in this order:
+  1) `$XDG_CONFIG_HOME/gup/gup.json` (if exists)
+  2) `./gup.json` (if exists)
+
+You can always override the path with `--file`.
 
 ```shell
 ※ Environments A (e.g. ubuntu)
 $ gup export
-Export /home/nao/.config/gup/gup.conf
+Export /home/nao/.config/gup/gup.json
 
 ※ Environments B (e.g. debian)
-$ ls /home/nao/.config/gup/gup.conf
-/home/nao/.config/gup/gup.conf
 $ gup import
 ```
 
-Alternatively, export subcommand print package information (it's same as gup.conf) that you want to export at STDOUT if you use --output option. import subcommand can also specify the gup.conf file path if you use --input option.
+`export` can print config content to STDOUT by `--output`. `import` can read a specific file by `--file`.
 ```shell
 ※ Environments A (e.g. ubuntu)
-$ gup export --output > gup.conf
+$ gup export --output > gup.json
 
 ※ Environments B (e.g. debian)
-$ gup import --input=gup.conf
+$ gup import --file=gup.json
 ```
 
 ### Generate man-pages (for linux, mac)
@@ -174,13 +210,16 @@ Generate /usr/share/man/man1/gup.1.gz
 ```
 
 ### Generate shell completion file (for bash, zsh, fish)
-completion subcommand generates shell completion files for bash, zsh, and fish. If the shell completion file does not exist in the system, the generation process will begin. To activate the completion feature, restart the shell.
+`completion` prints completion scripts to STDOUT when you pass a shell name.
+To install completion files into your user environment, use `--install`.
 
 ```shell
-$ gup completion
-create bash-completion file: /home/nao/.bash_completion
-create fish-completion file: /home/nao/.config/fish/completions/gup.fish
-create zsh-completion file: /home/nao/.zsh/completion/_gup
+$ gup completion bash > gup.bash
+$ gup completion zsh > _gup
+$ gup completion fish > gup.fish
+
+# Install files automatically to default user paths
+$ gup completion --install
 ```
 
 ### Desktop notification

cmd/bug_report.go

@@ -4,7 +4,9 @@ import (
 	"bytes"
 	"fmt"
 	"net/url"
+	"strings"
 
+	"github.com/nao1215/gup/internal/cmdinfo"
 	"github.com/spf13/cobra"
 )
 
@@ -28,6 +30,10 @@ type openBrowserFunc func(string) bool
 // bugReport opens the default browser to start a bug report which will include useful system information.
 func bugReport(cmd *cobra.Command, _ []string, openBrowser openBrowserFunc) int {
 	var buf bytes.Buffer
+	version := strings.TrimSpace(cmd.Version)
+	if version == "" {
+		version = cmdinfo.GetVersion()
+	}
 
 	const (
 		description = `## Description (About the problem)
@@ -46,7 +52,7 @@ Expected behavior.
 Any other useful data to share.
 `
 	)
-	buf.WriteString(fmt.Sprintf("## gup version\n%s\n\n", cmd.Version))
+	buf.WriteString(fmt.Sprintf("## gup version\n%s\n\n", version))
 	buf.WriteString(description)
 	buf.WriteString(toReproduce)
 	buf.WriteString(expectedBehavior)

cmd/bug_report_test.go

@@ -62,3 +62,20 @@ func Test_bugReport(t *testing.T) {
 		t.Errorf("bugReport() = %d; want %d", gotReturnVal, wantReturnVal)
 	}
 }
+
+func Test_bugReport_fallbackVersion(t *testing.T) {
+	t.Parallel()
+
+	cmd := newBugReportCmd()
+	cmd.Version = ""
+
+	gotReturnVal := bugReport(cmd, nil, func(s string) bool {
+		if !strings.Contains(s, "gup+version") {
+			t.Errorf("expected bug report URL to contain gup version section, but got: %s", s)
+		}
+		return true
+	})
+	if gotReturnVal != 0 {
+		t.Errorf("bugReport() = %d; want %d", gotReturnVal, 0)
+	}
+}

cmd/check.go

@@ -77,6 +77,7 @@ func doCheck(pkgs []goutil.Package, cpus int, ignoreGoUpdate bool) int {
 	countFmt := "[%" + pkgDigit(pkgs) + "d/%" + pkgDigit(pkgs) + "d]"
 	var mu sync.Mutex
 	needUpdatePkgs := []goutil.Package{}
+	verCache := newLatestVerCache()
 
 	print.Info("check binary under $GOPATH/bin or $GOBIN")
 
@@ -86,17 +87,30 @@ func doCheck(pkgs []goutil.Package, cpus int, ignoreGoUpdate bool) int {
 			err = fmt.Errorf(" %s is not installed by 'go install' (or permission incorrect)", p.Name)
 		} else {
 			var latestVer string
-			latestVer, err = goutil.GetLatestVer(p.ModulePath)
+			modulePathChanged := false
+			latestVer, err = verCache.get(p.ModulePath)
 			if err != nil {
-				err = fmt.Errorf(" %s %w", p.Name, err)
+				newPkg, changed := resolveModulePathChange(p, err)
+				if !changed {
+					err = fmt.Errorf(" %s %w", p.Name, err)
+				} else {
+					modulePathChanged = true
+					p = newPkg
+					latestVer, err = verCache.get(p.ModulePath)
+					if err != nil {
+						err = fmt.Errorf(" %s %w", p.Name, err)
+					}
+				}
 			}
-			p.Version.Latest = latestVer
-
-			shouldUpdate := !p.IsPackageUpToDate() || (!ignoreGoUpdate && !p.IsGoUpToDate())
-			if shouldUpdate {
-				mu.Lock()
-				needUpdatePkgs = append(needUpdatePkgs, p)
-				mu.Unlock()
+			if err == nil {
+				p.Version.Latest = latestVer
+
+				shouldUpdate := modulePathChanged || !p.IsPackageUpToDate() || (!ignoreGoUpdate && !p.IsGoUpToDate())
+				if shouldUpdate {
+					mu.Lock()
+					needUpdatePkgs = append(needUpdatePkgs, p)
+					mu.Unlock()
+				}
 			}
 		}
 

cmd/check_test.go

@@ -3,6 +3,7 @@ package cmd
 
 import (
 	"bytes"
+	"errors"
 	"io"
 	"os"
 	"path/filepath"
@@ -393,3 +394,69 @@ func Test_check_jobsClamp(t *testing.T) {
 		t.Errorf("check() = %v, want 0 or 1", got)
 	}
 }
+
+func Test_doCheck_modulePathChanged(t *testing.T) {
+	const (
+		oldModule = "github.com/cosmtrek/air"
+		newModule = "github.com/air-verse/air"
+	)
+
+	origGetLatest := getLatestVer
+	defer func() {
+		getLatestVer = origGetLatest
+	}()
+
+	getLatestVer = func(modulePath string) (string, error) {
+		if modulePath == oldModule {
+			return "", errors.New("version constraints conflict:\n" +
+				"module declares its path as: " + newModule + "\n" +
+				"but was required as: " + oldModule)
+		}
+		if modulePath == newModule {
+			return "v1.2.3", nil
+		}
+		return "", errors.New("unexpected module path")
+	}
+
+	orgStdout := print.Stdout
+	orgStderr := print.Stderr
+	pr, pw, err := os.Pipe()
+	if err != nil {
+		t.Fatal(err)
+	}
+	print.Stdout = pw
+	print.Stderr = pw
+
+	pkgs := []goutil.Package{
+		{
+			Name:       "air",
+			ImportPath: "github.com/cosmtrek/air/cmd/air",
+			ModulePath: oldModule,
+			Version: &goutil.Version{
+				Current: "v1.2.3",
+			},
+			GoVersion: &goutil.Version{
+				Current: "go1.22.4",
+				Latest:  "go1.22.4",
+			},
+		},
+	}
+	got := doCheck(pkgs, 1, true)
+
+	pw.Close()
+	print.Stdout = orgStdout
+	print.Stderr = orgStderr
+
+	buf := bytes.Buffer{}
+	if _, err := io.Copy(&buf, pr); err != nil {
+		t.Fatal(err)
+	}
+	_ = pr.Close()
+
+	if got != 0 {
+		t.Fatalf("doCheck() = %v, want 0", got)
+	}
+	if !strings.Contains(buf.String(), "$ gup update air ") {
+		t.Fatalf("expected update hint for migrated module path, got:\n%s", buf.String())
+	}
+}