Skip to content

Replace old docker compose filename #19582

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
Feb 26, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions .doctor-rst.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,7 @@ whitelist:
- '/``.yml``/'
- '/(.*)\.orm\.yml/' # currently DoctrineBundle only supports .yml
- /docker-compose\.yml/
Copy link
Contributor

Choose a reason for hiding this comment

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

this can be removed then

- /compose\.yaml/
Copy link
Contributor

Choose a reason for hiding this comment

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

this should not be needed

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 not aware of what this file is doing, can you explain it to me ?

Copy link
Contributor

Choose a reason for hiding this comment

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

Sure this list is to suppress a warning by out linter, but as this line will not produce this error anymore it can be removed

lines:
- 'in config files, so the old ``app/config/config_dev.yml`` goes to'
- '#. The most important config file is ``app/config/services.yml``, which now is'
Expand Down
2 changes: 1 addition & 1 deletion setup/docker.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Flex Recipes & Docker Configuration

The :ref:`Flex recipe <symfony-flex>` for some packages also include Docker configuration.
For example, when you run ``composer require doctrine`` (to get ``symfony/orm-pack``),
your ``docker-compose.yml`` file will automatically be updated to include a
your ``compose.yaml`` file will automatically be updated to include a
``database`` service.

The first time you install a recipe containing Docker config, Flex will ask you
Expand Down
12 changes: 6 additions & 6 deletions setup/symfony_server.rst
Original file line number Diff line number Diff line change
Expand Up @@ -388,7 +388,7 @@ Consider the following configuration:

.. code-block:: yaml

# docker-compose.yaml
# compose.yaml
services:
database:
ports: [3306]
Expand All @@ -401,12 +401,12 @@ variables accordingly with the service name (``database``) as a prefix:
If the service is not in the supported list below, generic environment
variables are set: ``PORT``, ``IP``, and ``HOST``.

If the ``docker-compose.yaml`` names do not match Symfony's conventions, add a
If the ``compose.yaml`` names do not match Symfony's conventions, add a
label to override the environment variables prefix:

.. code-block:: yaml

# docker-compose.yaml
# compose.yaml
services:
db:
ports: [3306]
Expand Down Expand Up @@ -471,7 +471,7 @@ check the "Symfony Server" section in the web debug toolbar; you'll see that

.. code-block:: yaml

# docker-compose.yaml
# compose.yaml
services:
db:
ports: [3306]
Expand All @@ -485,10 +485,10 @@ its location, same as for ``docker-compose``:
.. code-block:: bash

# start your containers:
COMPOSE_FILE=docker/docker-compose.yaml COMPOSE_PROJECT_NAME=project_name docker-compose up -d
COMPOSE_FILE=docker/compose.yaml COMPOSE_PROJECT_NAME=project_name docker-compose up -d

# run any Symfony CLI command:
COMPOSE_FILE=docker/docker-compose.yaml COMPOSE_PROJECT_NAME=project_name symfony var:export
COMPOSE_FILE=docker/compose.yaml COMPOSE_PROJECT_NAME=project_name symfony var:export

.. note::

Expand Down