Skip to content
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

Rename docker-compose.yml to compose.yaml #636

Merged
merged 1 commit into from
Aug 26, 2024

Conversation

bobbyiliev
Copy link
Contributor

As per the new Docker naming convention described in the docs here, renaming the docker-compose.yml to compose.yaml.

The default path for a Compose file is compose.yaml (preferred) or compose.yml that is placed in the working directory. Compose also supports docker-compose.yaml and docker-compose.yml for backwards compatibility of earlier versions. If both files exist, Compose prefers the canonical compose.yaml.

@bobbyiliev bobbyiliev requested a review from a team as a code owner August 26, 2024 16:15
@bobbyiliev bobbyiliev requested review from arusahni and removed request for a team August 26, 2024 16:15
Copy link
Contributor

@arusahni arusahni left a comment

Choose a reason for hiding this comment

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

How long has support for compose.yml been out in the wild? I wonder if this could break things for people using older tooling that doesn't yet support the new convention.

@bobbyiliev
Copy link
Contributor Author

How long has support for compose.yml been out in the wild? I wonder if this could break things for people using older tooling that doesn't yet support the new convention.

Yea, good point! Managed to find when the support for the compose.yml and compose.yaml was actually introduced and it seems like it's been there for quite a while already: https://docs.docker.com/compose/release-notes/#1286

My guess is that they will keep the docker-compose.yaml fallback for quite a while!

@bobbyiliev bobbyiliev merged commit 08b526a into main Aug 26, 2024
2 checks passed
@bobbyiliev bobbyiliev deleted the docker-compose-new-naming branch August 26, 2024 18:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants