Skip to content
New issue

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

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

Already on GitHub? # to your account

Support new trellis.cli.yml config file #387

Merged
merged 1 commit into from
Apr 23, 2023
Merged

Conversation

swalkinshaw
Copy link
Member

@swalkinshaw swalkinshaw commented Apr 16, 2023

Adds more supported config files. In order of precedence, the following paths will be loaded:

  • .trellis/cli.yml - existing file, now considered deprecated
  • trellis.cli.yml - new path
  • trellis.cli.local.yml - optional local override config

This change is being done to allow the .trellis directory to be gitigored as it contains CLI generated files that are machine specific and should not be committed to Git.

@swalkinshaw
Copy link
Member Author

I'm still considering other CLI config names. Here are some options:

  • cli.yml
  • .cli.yml

I think trellis.yml is too confusing right now since it doesn't mention CLI and all the current config settings are much more related to the CLI than Trellis itself.

And I'm 50/50 on whether to use the leading . to make it a hidden file or not. Since the file is optional (and additive), and not directly used by Trellis, the dot prefix makes that more obvious. But what's the actual point in hiding it? The leading . is more annoying to use and it makes it less visible.

@swalkinshaw swalkinshaw changed the title Support .trellis.cli.yml config file Support trellis.cli.yml config file Apr 19, 2023
@swalkinshaw swalkinshaw changed the title Support trellis.cli.yml config file Support new trellis.cli.yml config file Apr 23, 2023
@swalkinshaw
Copy link
Member Author

Got some community feedback and decided to go with trellis.cli.yml.

  • it has CLI in the name to differentiate it from playbook files and make it obvious it's for the CLI
  • not a hidden file which makes it more visible

Adds more supported config files. In order of precedence, the following
paths will be loaded:

* `.trellis/cli.yml` - existing file, now considered deprecated
* `trellis.cli.yml` - new path
* `trellis.cli.local.yml` - optional local override config

This change is being done to allow the `.trellis` directory to be
gitigored as it contains CLI generated files that are machine specific
and should not be committed to Git.
@swalkinshaw swalkinshaw merged commit edf380a into master Apr 23, 2023
@swalkinshaw swalkinshaw deleted the new-config-file branch April 23, 2023 01:15
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant