chore: rename docker-compose.yaml to compose.yaml #19480
Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR renames the Docker Compose configuration file from docker-compose.yaml to compose.yaml and updates all documentation references to reflect this change. This aligns with Docker Compose v2's preferred naming convention.
- Renamed
docker-compose.yamltocompose.yaml - Updated documentation references across multiple files to use the new filename
- Removed the deprecated
versionfield from the compose file
Reviewed Changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| docs/tutorials/reverse-proxy-caddy.md | Updated references from docker-compose.yaml to compose.yaml and modernized Docker Compose command syntax |
| docs/install/docker.md | Updated file references and links to point to the new compose.yaml filename |
| docs/admin/networking/workspace-proxies.md | Updated Docker Compose file reference to use new filename |
| compose.yaml | Removed deprecated version field from compose file |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
| @@ -50,14 +50,14 @@ docker run --rm -it \ | |||
| ## Install Coder via `docker compose` | |||
|
|
|||
| Coder's publishes a | |||
| [docker-compose example](https://github.com/coder/coder/blob/main/docker-compose.yaml) | |||
| [docker compose example](https://github.com/coder/coder/blob/main/compose.yaml) | |||
There was a problem hiding this comment.
🚫 [linkspector] reported by reviewdog 🐶
Cannot reach https://github.com/coder/coder/blob/main/compose.yaml Status: 404
| which includes an PostgreSQL container and volume. | ||
|
|
||
| 1. Make sure you have [Docker Compose](https://docs.docker.com/compose/install/) | ||
| installed. | ||
|
|
||
| 1. Download the | ||
| [`docker-compose.yaml`](https://github.com/coder/coder/blob/main/docker-compose.yaml) | ||
| [`docker-compose.yaml`](https://github.com/coder/coder/blob/main/compose.yaml) |
There was a problem hiding this comment.
🚫 [linkspector] reported by reviewdog 🐶
Cannot reach https://github.com/coder/coder/blob/main/compose.yaml Status: 404
| @@ -178,7 +178,7 @@ regular Coder server. | |||
| #### Docker Compose | |||
|
|
|||
| Change the provided | |||
| [`docker-compose.yml`](https://github.com/coder/coder/blob/main/docker-compose.yaml) | |||
| [`compose.yml`](https://github.com/coder/coder/blob/main/compose.yaml) | |||
There was a problem hiding this comment.
🚫 [linkspector] reported by reviewdog 🐶
Cannot reach https://github.com/coder/coder/blob/main/compose.yaml Status: 404
There was a problem hiding this comment.
Will get resolved once merged.
Docker recommends using a
compose.yamlfile.