Skip to content

Update configuration.rst and deployment.rst for dotenv:dump command #16416

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
Jul 13, 2023

Conversation

mertingen
Copy link
Contributor

It changes from "composer dump-env prod" to "php bin/console dotenv:dump prod"

@carsonbot carsonbot added this to the 5.4 milestone Jan 19, 2022
@mertingen mertingen changed the title Update configuration.rst for dotenv:dump command Update configuration.rst and deployment.rst for dotenv:dump command Jan 19, 2022
@wouterj
Copy link
Member

wouterj commented Jan 19, 2022

Hi!

This command is a bit special, as we need to register it first (see the PR description in symfony/symfony#42610 (comment)):

The command is not registered by default. In order to enable it, one must add it to their services.yaml file:

services:
    Symfony\Component\Dotenv\Command\DotenvDumpCommand:
        - '%kernel.project_dir%/.env'
        - '%kernel.environment%'

I think we should document this only once, in the configuration article. And then in the deployments article, we should only add a small tip like: "If Composer is not available during deployment, you can also use the dotenv:dump command. Read ... for more information."

@mertingen
Copy link
Contributor Author

Hi,

If I get the PR description without changing it and put it into the configuration documentation directly, do you mind? Because it is really good enough explicit.

I'll add the following tip in the deployment but how can I handle "read ... for more information"? Should I give the "configuration" page URL directly there?

"If Composer is not available during deployment, you can also use the dotenv:dump command. Read ... for more information."

@wouterj
Copy link
Member

wouterj commented Jan 20, 2022

If I get the PR description without changing it and put it into the configuration documentation directly, do you mind? Because it is really good enough explicit.

Fine by me (I would replace "one must" with "you must" though).

I'll add the following tip in the deployment but how can I handle "read ... for more information"? Should I give the "configuration" page URL directly there?

You can use :ref:`configuration-env-var-in-prod` to link directly to the correct section in the configuration page.

@mertingen
Copy link
Contributor Author

hi @wouterj

Thanks for the answer. I have got a quick question regarding deployment.rst. We edited it like the image.

43434

Should we add composer tip here? Because we already recommend using dotenv command for dumping.

@wouterj
Copy link
Member

wouterj commented Jan 25, 2022

I think we can keep composer at first, and then reference the configuration section to say "if you don't have composer, use this command". Anyway, feel free to update the PR as you like it best. We can apply little reorganizations during the merge, if we think something else is better.

@javiereguiluz
Copy link
Member

Mert, thanks for this contribution! While merging I did the final change asked by Wouter (see 679be09)

@mertingen
Copy link
Contributor Author

Brilliant! Thank you actually.

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