Skip to content

fix: auto-bootstrap root.json and create bin dir on first run #2709

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
yahonda wants to merge 2 commits into
base: master
Choose a base branch
from
+27 −6
Open

fix: auto-bootstrap root.json and create bin dir on first run #2709

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
22ab2e7
fix: auto-bootstrap root.json and create bin dir on first run
yahonda Jun 4, 2026
86ccffc
env: keep ErrInstallFirst as a pingcap error and clarify bootstrap co…
yahonda Jun 4, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 22 additions & 6 deletions pkg/environment/env.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,14 +14,15 @@
package environment

import (
"errors"
"fmt"
"os"
"path/filepath"
"sort"
"strings"
"time"

"github.com/pingcap/errors"
perrs "github.com/pingcap/errors"
"github.com/pingcap/tiup/pkg/localdata"
"github.com/pingcap/tiup/pkg/repository"
"github.com/pingcap/tiup/pkg/repository/v1manifest"
Expand All @@ -32,7 +33,7 @@ import (

var (
// ErrInstallFirst indicates that a component/version is not installed
ErrInstallFirst = errors.New("component not installed")
ErrInstallFirst = perrs.New("component not installed")
)

// EnvList is the canonical allowlist of environment variables TiUP will print or expose.
Expand Down Expand Up @@ -144,7 +145,22 @@ func InitEnv(options repository.Options, mOpt repository.MirrorOptions) (*Enviro
var local v1manifest.LocalManifests
local, err = v1manifest.NewManifests(profile)
if err != nil {
return nil, errors.Annotatef(err, "initial repository from mirror(%s) failed", mirrorAddr)
if errors.Is(err, v1manifest.ErrLoadManifest) {
// Only bootstrap root.json when the file is actually missing.
// If it exists but can't be read (e.g. permissions), preserve the
// original error rather than overwriting it.
rootPath := profile.Path("bin", "root.json")
if _, statErr := os.Stat(rootPath); os.IsNotExist(statErr) {
// Use the configured mirrorAddr so that custom/test mirrors are respected.
if err := profile.ResetMirror(mirrorAddr, ""); err != nil {
return nil, perrs.Annotatef(err, "initial repository from mirror(%s) failed", mirrorAddr)
}
local, err = v1manifest.NewManifests(profile)
}
}
if err != nil {
return nil, perrs.Annotatef(err, "initial repository from mirror(%s) failed", mirrorAddr)
}
}
v1repo = repository.NewV1Repo(mirror, options, local)

Expand Down Expand Up @@ -222,7 +238,7 @@ func (env *Environment) SelectInstalledVersion(component string, ver utils.Versi
versions := []string{}
for _, v := range installed {
vi, err := env.v1Repo.LocalComponentVersion(component, v, true)
if errors.Cause(err) == repository.ErrUnknownVersion {
if perrs.Cause(err) == repository.ErrUnknownVersion {
continue
}
if err != nil {
Expand All @@ -238,9 +254,9 @@ func (env *Environment) SelectInstalledVersion(component string, ver utils.Versi
return semver.Compare(versions[i], versions[j]) > 0
})

errInstallFirst := errors.Annotatef(ErrInstallFirst, "use `tiup install %s` to install component `%s` first", component, component)
errInstallFirst := perrs.Annotatef(ErrInstallFirst, "use `tiup install %s` to install component `%s` first", component, component)
if !ver.IsEmpty() {
errInstallFirst = errors.Annotatef(ErrInstallFirst, "use `tiup install %s:%s` to install specified version", component, ver.String())
errInstallFirst = perrs.Annotatef(ErrInstallFirst, "use `tiup install %s:%s` to install specified version", component, ver.String())
}

if ver.IsEmpty() || string(ver) == utils.NightlyVersionAlias {
Expand Down
5 changes: 5 additions & 0 deletions pkg/localdata/profile.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -224,6 +224,11 @@ func (p *Profile) VersionIsInstalled(component, version string) (bool, error) {

// ResetMirror reset root.json and cleanup manifests directory
func (p *Profile) ResetMirror(addr, root string) error {
// Ensure bin directory exists
if err := os.MkdirAll(p.Path("bin"), 0755); err != nil {
return err
}

// Calculating root.json path
shaWriter := sha256.New()
if _, err := io.Copy(shaWriter, strings.NewReader(addr)); err != nil {
Expand Down
Loading