Skip to content

feat: add docker-compose.prod.override.yml support#1221

Merged
DawoudSheraz merged 1 commit intooverhangio:releasefrom
mitodl:nl/docker-compose-prod-override
May 14, 2025
Merged

feat: add docker-compose.prod.override.yml support#1221
DawoudSheraz merged 1 commit intooverhangio:releasefrom
mitodl:nl/docker-compose-prod-override

Conversation

@rhysyngsun
Copy link
Copy Markdown
Contributor

This adds support for an optional docker-compose.prod.override.yml file used for tutor local commands. I'm proposing this because the current documentation suggests you can use docker-compose.override.yml to override services defined in docker-compose.prod.yml, but in practice this always errors.

Any tutor dev commands will try to use it and fail. Additionally even trying to run tutor local start (really anything that invokes docker compose [start|up|restart]) causes the equivalent of tutor dev dc stop to run, which will fail as services like caddy aren't defined for that project.

This example if put in docker-compose.override.yml will fail (under both tutor dev and tutor local), but if put in docker-compose.prod.override.yml both commands will work as expected:

services:
  caddy:
    labels:
      - "key=value"

@DawoudSheraz DawoudSheraz moved this from Pending Triage to In Progress in Tutor project management Apr 29, 2025
@DawoudSheraz DawoudSheraz moved this from In Progress to Pending Triage in Tutor project management Apr 29, 2025
@DawoudSheraz DawoudSheraz moved this from Pending Triage to In review in Tutor project management May 2, 2025
<!-- - [Improvement] This is a non-breaking change. Life is good. (by @billgates) -->

- [Improvement] Add support for `docker-compose.prod.override.yml` when using
`tutor local` commands
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

  • please add your github username at the end of changelog entry.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Note that adding the username in the changelog entry is optional. If OP does not need public recognition, that's fine :-)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

@rhysyngsun Hi, are you good with merging this without mentioning your GitHub in the changelog entry? You can update the changelog if you want to. Thanks

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

You can merge it as-is.

Copy link
Copy Markdown
Contributor

@DawoudSheraz DawoudSheraz left a comment

Choose a reason for hiding this comment

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

Once the changelog is updated, this will be merged.

@DawoudSheraz DawoudSheraz merged commit 477e98d into overhangio:release May 14, 2025
3 checks passed
@github-project-automation github-project-automation bot moved this from In review to Done in Tutor project management May 14, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Development

Successfully merging this pull request may close these issues.

4 participants