Is it safe to run the trellis-cli commands from inside the trellis folder

Alaa_Alsabbagh · October 3, 2022, 7:35pm

Hello,
I changed the default “site” folder name to be the name of my site but after that the trellis-cli commands no longer working because trellis-cli check about the existence of the “site” folder as shown here:

github.com

roots/trellis-cli/blob/271cf69e95120ea9e4e2f7ad1c2d634436dbdf98/trellis/detector.go#L41


      
          		}
          
          
		return p.Detect(parent)
          	}
          
          
	return path, true
          }
          
          
func (p *ProjectDetector) detectTrellisCLIProject(path string) bool {
          	trellisPath := filepath.Join(path, "trellis")
          	sitePath := filepath.Join(path, "site")
          	configPath := filepath.Join(trellisPath, ConfigDir)
          
          
	trellisDir, err := os.Stat(trellisPath)
          	if err != nil {
          		return false
          	}
          
          
	configDir, err := os.Stat(configPath)
          	if err != nil {
          		return false

but I figured that if I entered the “trellis” folder then run the trellis-cli commands it works.

So is it safe to run the trellis-cli commands from inside the “trellis” folder or not?

swalkinshaw · October 3, 2022, 9:42pm

Yeah sorry right now it’s a limitation that the folder has to be called site.

Of course! That’s where Ansible commands would normally be run if you weren’t using trellis-cli. But again, the CLI won’t detect you’re in a project without the site folder.

Alaa_Alsabbagh · October 4, 2022, 7:48am

But actually the trellis-cli commands works correctly without site folder if I run them within the trellis folder because it checks about this pattern before, to detect if i am in a project:

github.com

roots/trellis-cli/blob/10b0f1f6dcbfc131fb20416748a91871e92638b4/trellis/detector.go#L20


      
          }
          
          
type ProjectDetector struct{}
          
          
/*
          Detect if a path is a Trellis project or not
          This will traverse up the directory tree until it finds a valid project,
          or stop at the root and give up.
          */
          func (p *ProjectDetector) Detect(path string) (projectPath string, ok bool) {
          	configPaths, _ := filepath.Glob(filepath.Join(path, GlobPattern))
          
          
	if len(configPaths) == 0 {
          		if p.detectTrellisCLIProject(path) {
          			return filepath.Join(path, "trellis"), true
          		}
          
          
		parent := filepath.Dir(path)
          
          
		if len(parent) == 1 && (parent == "." || os.IsPathSeparator(parent[0])) {
          			return "", false

github.com

roots/trellis-cli/blob/d1f6e6f2b6bc2f3d56eba6c51317d6c72026775d/trellis/trellis.go#L19


      
          	"sort"
          	"strings"
          
          
	"github.com/mitchellh/cli"
          	"gopkg.in/ini.v1"
          	"gopkg.in/yaml.v2"
          )
          
          
const ConfigDir = ".trellis"
          const ConfigFile = "cli.yml"
          const GlobPattern = "group_vars/*/wordpress_sites.yml"
          
          
type Options struct {
          	Detector  Detector
          	ConfigDir string
          }
          
          
type TrellisOption func(*Trellis)
          
          
type Trellis struct {
          	CliConfig       *CliConfig

Is that right ?

swalkinshaw · October 4, 2022, 12:37pm

Yeah that’s right sorry It will work directly in any trellis folder.

I’m probably going to remove that site check entirely which will make this more flexible for other setups like yours. I realized it’s not doing anything functional; it was originally meant to cut down on false positives but detecting a “trellis” folder with 1) group_vars configs and 2) a .trellis config dir is enough on its own.