[PR #3213] Rename docker-compose.yml to compose.yaml #36887

Open
opened 2026-06-18 22:09:06 -05:00 by GiteaMirror · 0 comments
Owner

📋 Pull Request Information

Original PR: https://github.com/fosrl/pangolin/pull/3213
Author: @ivenos
Created: 6/4/2026
Status: 🔄 Open

Base: mainHead: rename-to-compose-yaml


📝 Commits (1)

  • 89f3f3c Rename docker-compose.yml to compose.yaml

📊 Changes

5 files changed (+0 additions, -0 deletions)

View changed files

📝 compose.drizzle.yaml (+0 -0)
📝 compose.example.yaml (+0 -0)
📝 compose.mailpit.yaml (+0 -0)
📝 compose.pgr.yaml (+0 -0)
📝 compose.yaml (+0 -0)

📄 Description

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.yaml is the canonical filename; docker-compose.yml is only a legacy fallback.

Changes

  • Rename the repository's Compose files:
    • docker-compose.ymlcompose.yaml
    • docker-compose.example.ymlcompose.example.yaml
    • docker-compose.pgr.ymlcompose.pgr.yaml
    • docker-compose.mailpit.ymlcompose.mailpit.yaml
    • docker-compose.drizzle.ymlcompose.drizzle.yaml

No behavior change: docker compose discovers either filename, so existing setups are unaffected. There was no top-level version field 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 deployment docker-compose.yml and is coupled to that exact filename (backups, -f docker-compose.yml, podman-compose). Renaming it there would break upgrades of existing deployments. The resourceExposePortsEditFile UI strings, which point users at that installer-generated file, are likewise left as docker-compose.yml.

How to test?

  • docker compose config in the repo root resolves compose.yaml through auto-discovery (no -f needed).
  • docker compose -f compose.example.yaml config, -f compose.pgr.yaml config, and -f compose.mailpit.yaml config validate successfully.
  • docker compose -f compose.pgr.yaml -f compose.drizzle.yaml config validates (the drizzle overlay depends on the db service from the pgr file, same as before the rename).

🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.

## 📋 Pull Request Information **Original PR:** https://github.com/fosrl/pangolin/pull/3213 **Author:** [@ivenos](https://github.com/ivenos) **Created:** 6/4/2026 **Status:** 🔄 Open **Base:** `main` ← **Head:** `rename-to-compose-yaml` --- ### 📝 Commits (1) - [`89f3f3c`](https://github.com/fosrl/pangolin/commit/89f3f3c8cdcfa06f478bb333820d55f0f178d3a2) Rename docker-compose.yml to compose.yaml ### 📊 Changes **5 files changed** (+0 additions, -0 deletions) <details> <summary>View changed files</summary> 📝 `compose.drizzle.yaml` (+0 -0) 📝 `compose.example.yaml` (+0 -0) 📝 `compose.mailpit.yaml` (+0 -0) 📝 `compose.pgr.yaml` (+0 -0) 📝 `compose.yaml` (+0 -0) </details> ### 📄 Description ## 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](https://docs.docker.com/compose/intro/compose-application-model/): - `compose.yaml` is the canonical filename; `docker-compose.yml` is only a legacy fallback. ### Changes - Rename the repository's Compose files: - `docker-compose.yml` → `compose.yaml` - `docker-compose.example.yml` → `compose.example.yaml` - `docker-compose.pgr.yml` → `compose.pgr.yaml` - `docker-compose.mailpit.yml` → `compose.mailpit.yaml` - `docker-compose.drizzle.yml` → `compose.drizzle.yaml` No behavior change: `docker compose` discovers either filename, so existing setups are unaffected. There was no top-level `version` field 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 deployment `docker-compose.yml` and is coupled to that exact filename (backups, `-f docker-compose.yml`, `podman-compose`). Renaming it there would break upgrades of existing deployments. The `resourceExposePortsEditFile` UI strings, which point users at that installer-generated file, are likewise left as `docker-compose.yml`. ## How to test? - `docker compose config` in the repo root resolves `compose.yaml` through auto-discovery (no `-f` needed). - `docker compose -f compose.example.yaml config`, `-f compose.pgr.yaml config`, and `-f compose.mailpit.yaml config` validate successfully. - `docker compose -f compose.pgr.yaml -f compose.drizzle.yaml config` validates (the drizzle overlay depends on the `db` service from the pgr file, same as before the rename). --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
GiteaMirror added the pull-request label 2026-06-18 22:09:06 -05:00
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: github-starred/pangolin#36887