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

Update Docker Compose file references and commands #142

Draft
wants to merge 1 commit into
base: v3
Choose a base branch
from

Conversation

fouteox
Copy link

@fouteox fouteox commented Dec 12, 2024

Docker documentation now recommends to use compose.yaml as name for "docker compose" files. See link below.

I think v3 is a good time. That's why I made the changes on v3 only.

I added backwards compatibility with old names, maybe it would be better to add deprecated message when running spin commands?

https://docs.docker.com/compose/intro/compose-application-model/

I can create a pull request for other repositories that expect the name "docker-compose.*.yml", I just need a list of repositories :) (like spin-pro, etc)

Replaced all instances of 'docker-compose.yml' and related files with the newer 'compose.yaml' naming convention across documentation and scripts. Adjusted checks, error messages, and commands to handle both file formats where necessary.
@jaydrogers jaydrogers marked this pull request as draft December 12, 2024 14:54
@jaydrogers
Copy link
Member

Wow, thanks for pointing this out to me! I wasn't aware of this change.

This is quite a big change, and before I introduce it into v3 I think it's best to put this in a future release. I'd hate to scope creep myself after how much testing we have into Spin v3 (it's very close for release).

The challenge is we will need to support:

  • docker-compose.*.yml
  • compose.*.yaml
  • compose.*.yml

With their .yaml ending, I've gotta say -- as a sysadmin for 20 years, I don't think I've ever used .yaml in my life 😆

Regardless, we would have to make changes to support the other files.

Let's keep this open for now so it's on our radar, and once we get through Spin v3, we can circle back. It seems as if they will be supporting the old method for a while and I am sure it will take the industry a while to adapt to a change like this.

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