Skip to content
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.

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

Replace docker-compose with docker compose in just scripts and docs #4017

Merged
merged 4 commits into from
Apr 3, 2024

Conversation

obulat
Copy link
Contributor

@obulat obulat commented Apr 3, 2024

Fixes

Related to #3876 by @zackkrida

Description

This PR only replaces docker-compose in justfiles and documentation with docker compose.
It does not simplify the docker ps script.
@zackkrida mentions the replacement of underscores with dashes for container names in the issue: should this be done manually? Would it also affect production?

I think it's best to keep the scope of this PR small to fix the critical issue of CI failures due to docker-compose command not being found.

Testing Instructions

The CI should pass.
All of the just commands that used to use docker-compose should work as usual.

Checklist

  • My pull request has a descriptive title (not a vague title likeUpdate index.md).
  • My pull request targets the default branch of the repository (main) or a parent feature branch.
  • My commit messages follow best practices.
  • My code follows the established code style of the repository.
  • I added or updated tests for the changes I made (if applicable).
  • I added or updated documentation (if applicable).
  • I tried running the project locally and verified that there are no visible errors.
  • I ran the DAG documentation generator (if applicable).

Developer Certificate of Origin

Developer Certificate of Origin
Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.


Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.

@openverse-bot openverse-bot added the 🚦 status: awaiting triage Has not been triaged & therefore, not ready for work label Apr 3, 2024
@github-actions github-actions bot added 🧱 stack: documentation Related to Sphinx documentation 🧱 stack: ingestion server Related to the ingestion/data refresh server labels Apr 3, 2024
@obulat obulat added 🟥 priority: critical Must be addressed ASAP ✨ goal: improvement Improvement to an existing user-facing feature 🤖 aspect: dx Concerns developers' experience with the codebase 🧱 stack: mgmt Related to repo management and automations and removed 🚦 status: awaiting triage Has not been triaged & therefore, not ready for work labels Apr 3, 2024
Copy link

github-actions bot commented Apr 3, 2024

Full-stack documentation: https://docs.openverse.org/_preview/4017

Please note that GitHub pages takes a little time to deploy newly pushed code, if the links above don't work or you see old versions, wait 5 minutes and try again.

You can check the GitHub pages deployment action list to see the current status of the deployments.

Changed files 🔄:

Signed-off-by: Olga Bulat <obulat@gmail.com>
@obulat obulat marked this pull request as ready for review April 3, 2024 09:47
@obulat obulat requested review from a team as code owners April 3, 2024 09:47
Copy link
Member

@dhruvkb dhruvkb left a comment

Choose a reason for hiding this comment

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

The changes look good to me.

The underscore and dash change is a non-issue for us especially if we use the docker compose exec command with service names instead of container names.

I have more confidence in the changes because many folks on the team, myself included, have been using Compose v2 for a while and it has not affected anything for us.

I do have some nits about capitalisation but those are not blockers. The blocker is the V2 → v3 upgrade in docker-compose.yml.

ingestion_server/test/integration_test.py Outdated Show resolved Hide resolved
documentation/frontend/reference/playwright_tests.md Outdated Show resolved Hide resolved
docker-compose.yml Outdated Show resolved Hide resolved
Co-authored-by: Dhruv Bhanushali <hi@dhruvkb.dev>
docker-compose.yml Outdated Show resolved Hide resolved
@obulat obulat requested a review from dhruvkb April 3, 2024 11:26
Copy link
Collaborator

@AetherUnbound AetherUnbound left a comment

Choose a reason for hiding this comment

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

Thanks for making this change! I encountered it yesterday but it was successful after a second run. Weird!

@AetherUnbound AetherUnbound merged commit e7da5d6 into main Apr 3, 2024
44 checks passed
@AetherUnbound AetherUnbound deleted the compose-v2 branch April 3, 2024 15:59
@krysal krysal added 🧰 goal: internal improvement Improvement that benefits maintainers, not users and removed ✨ goal: improvement Improvement to an existing user-facing feature labels Apr 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🤖 aspect: dx Concerns developers' experience with the codebase 🧰 goal: internal improvement Improvement that benefits maintainers, not users 🟥 priority: critical Must be addressed ASAP 🧱 stack: documentation Related to Sphinx documentation 🧱 stack: ingestion server Related to the ingestion/data refresh server 🧱 stack: mgmt Related to repo management and automations
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

5 participants