Skip to content

Symfony CLI: document the .symfony.local.yaml config file #17562

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.

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

Merged
merged 1 commit into from
Dec 27, 2022

Conversation

jmsche
Copy link
Contributor

@jmsche jmsche commented Dec 14, 2022

It seems there are some other options available for the .symfony.local.yaml configuration file: https://github.com/symfony-cli/symfony-cli/blob/862b631e07adc07a534ef5349cbffa6006b76f41/local/project/config.go#L34-L61

I think this PR documents all of them :)

@carsonbot carsonbot added this to the 5.4 milestone Dec 14, 2022
Comment on lines +299 to +303
# Sets domain1.wip and domain2.wip for the current project
proxy:
domains:
- domain1
- domain2
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm wondering if this should not be moved to the proxy section 🤔.
Basically pin every part of the YAML to its dedicated feature section.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm open to move it if it's really wanted?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

After thinking about this, I think it's better for now to keep all options of the config file in the same section, because it's not very long. In any case, if we realize that this is not working well, we can quickly update this in a future PR to do what @tucksaun suggested.

@javiereguiluz
Copy link
Member

Thank you @jmsche.

@javiereguiluz javiereguiluz force-pushed the symfony_cli_config_file branch from 1498387 to 4f17fcb Compare December 27, 2022 16:54
@javiereguiluz javiereguiluz merged commit 65d8034 into symfony:5.4 Dec 27, 2022
@jmsche jmsche deleted the symfony_cli_config_file branch February 20, 2023 13:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants