Skip to content

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

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.

Sign up for GitHub

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

Merged
DawoudSheraz merged 1 commit into from
May 14, 2025
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions changelog.d/20250416_123930_nlevesq_docker_compose_prod_override.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
<!--
Create a changelog entry for every new user-facing change. Please respect the following instructions:
- Indicate breaking changes by prepending an explosion 💥 character.
- Prefix your changes with either [Bugfix], [Improvement], [Feature], [Security], [Deprecation].
- You may optionally append "(by @<author>)" at the end of the line, where "<author>" is either one (just one)
of your GitHub username, real name or affiliated organization. These affiliations will be displayed in
the release notes for every release.
-->

<!-- - 💥[Feature] Foobarize the blorginator. This breaks plugins by renaming the `FOO_DO` filter to `BAR_DO`. (by @regisb) -->
<!-- - [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

@DawoudSheraz DawoudSheraz May 6, 2025

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

@regisb regisb May 6, 2025

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

@DawoudSheraz DawoudSheraz May 13, 2025

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

@rhysyngsun rhysyngsun May 13, 2025

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.


4 changes: 3 additions & 1 deletion docs/local.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -218,6 +218,8 @@ You might want to customise the docker-compose services listed in ``$(tutor conf

vim $(tutor config printroot)/env/local/docker-compose.override.yml

The values in this file will override the values from ``docker-compose.yml`` and ``docker-compose.prod.yml``, as explained in the `docker-compose documentation <https://docs.docker.com/compose/extends/#adding-and-overriding-configuration>`__.
The values in this file will override the values from ``docker-compose.yml`` as explained in the `docker-compose documentation <https://docs.docker.com/compose/extends/#adding-and-overriding-configuration>`__.

Services defined in ``docker-compose.prod.yml`` can be overriden in a ``docker-compose.prod.override.yml`` file in that same folder.

Similarly, the job service configuration can be overridden by creating a ``docker-compose.jobs.override.yml`` file in that same folder.
1 change: 1 addition & 0 deletions tutor/commands/local.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ def __init__(self, root: str, config: Config):
tutor_env.pathjoin(self.root, "local", "docker-compose.yml"),
tutor_env.pathjoin(self.root, "local", "docker-compose.prod.yml"),
tutor_env.pathjoin(self.root, "local", "docker-compose.override.yml"),
tutor_env.pathjoin(self.root, "local", "docker-compose.prod.override.yml"),
]
self.docker_compose_job_files += [
tutor_env.pathjoin(self.root, "local", "docker-compose.jobs.yml"),
Expand Down