Rename docker-compose.yml to compose.yaml#3213
Open
ivenos wants to merge 1 commit into
Open
Conversation
Contributor
|
Eh that's a bit messy to use -f If I want to overlay I just use profiles or overrides. Profiles preferably, Just depends if the CI/CD tools in the repo are looking for docker-compose or just running the raw commands, Would likely look into that. |
Contributor
|
Else looks fine to me |
Contributor
Author
|
CI builds via Profiles would be cleaner than -f, agreed. That overlay predates this PR though, so I kept this one a plain rename. Could be a separate PR. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Community Contribution License Agreement
By creating this pull request, I grant the project maintainers an unlimited,
perpetual license to use, modify, and redistribute these contributions under any terms they
choose, including both the AGPLv3 and the Fossorial Commercial license terms. I
represent that I have the right to grant this license for all contributed content.
Description
Aligns the project with the current Compose Specification:
compose.yamlis the canonical filename;docker-compose.ymlis only a legacy fallback.Changes
docker-compose.yml→compose.yamldocker-compose.example.yml→compose.example.yamldocker-compose.pgr.yml→compose.pgr.yamldocker-compose.mailpit.yml→compose.mailpit.yamldocker-compose.drizzle.yml→compose.drizzle.yamlNo behavior change:
docker composediscovers either filename, so existing setups are unaffected. There was no top-levelversionfield to drop, and none of these files are referenced by exact name anywhere in the repo. These are pure renames (100% similarity).The installer (
install/) is intentionally left unchanged: it generates and manages the end user's deploymentdocker-compose.ymland is coupled to that exact filename (backups,-f docker-compose.yml,podman-compose). Renaming it there would break upgrades of existing deployments. TheresourceExposePortsEditFileUI strings, which point users at that installer-generated file, are likewise left asdocker-compose.yml.How to test?
docker compose configin the repo root resolvescompose.yamlthrough auto-discovery (no-fneeded).docker compose -f compose.example.yaml config,-f compose.pgr.yaml config, and-f compose.mailpit.yaml configvalidate successfully.docker compose -f compose.pgr.yaml -f compose.drizzle.yaml configvalidates (the drizzle overlay depends on thedbservice from the pgr file, same as before the rename).