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

docs: update deprecated/outdated compose syntax and filenames #2514

Merged
merged 1 commit into from
Dec 6, 2024

Conversation

dvdksn
Copy link
Contributor

@dvdksn dvdksn commented Dec 6, 2024

Not an exhaustive update (didn't want to touch the stack.yml stuff yet, could do in a follow-up) but updated references to old docker-compose binary and changed the filename from docker-compose.yml to compose.yaml, where it made sense to do so.

Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
@dvdksn dvdksn marked this pull request as ready for review December 6, 2024 12:50
@tianon
Copy link
Member

tianon commented Dec 6, 2024

We really went with the four-character file extension convention? 😭 (compose.yaml)


You can use this [stack](https://github.com/convertigo/docker/blob/master/compose/mbaas/docker-compose.yml) to run a complete Convertigo Low Code server with FullSync repository and MySQL analytics in a few command lines.
You can use [this Docker Compose file](https://github.com/convertigo/docker/blob/master/compose/mbaas/docker-compose.yml) to run a complete Convertigo Low Code server with FullSync repository and MySQL analytics in a few command lines.

```console
$ mkdir c8oMBaaS
$ cd c8oMBaaS
$ wget https://raw.githubusercontent.com/convertigo/docker/master/compose/mbaas/docker-compose.yml
Copy link
Member

Choose a reason for hiding this comment

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

Does this need -O compose.yaml?

Copy link
Member

@tianon tianon Dec 6, 2024

Choose a reason for hiding this comment

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

I guess not because Compose will still pick up the older filename ? . 👀

Copy link
Member

@tianon tianon left a comment

Choose a reason for hiding this comment

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

Generally looks OK, thanks!

I really dislike compose.yaml and would prefer compose.yml (or even docker-compose.yml 🙃) but I'll defer to the canonical upstream convention preference. 🙇

@tianon
Copy link
Member

tianon commented Dec 6, 2024

Took a bunch of digging, but finally found what I was looking for in https://github.com/compose-spec/compose-go/blob/9a9cc5d9c3453326bb8d506259bcfccd68af110b/cli/options.go#L384-L385

// DefaultFileNames defines the Compose file names for auto-discovery (in order of preference)
var DefaultFileNames = []string{"compose.yaml", "compose.yml", "docker-compose.yml", "docker-compose.yaml"}

So, I guess this is the upstream canonical preference. 🙃

@tianon tianon merged commit 2613481 into docker-library:master Dec 6, 2024
6 checks passed
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.

3 participants