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

Update docker compose command to V2 #879

Merged
merged 2 commits into from
Aug 4, 2024

Conversation

kokodak
Copy link
Member

@kokodak kokodak commented Aug 3, 2024

What this PR does / why we need it?

This PR changes the command in docker compose V1 that was being used by the CI workflow to the V2 command, so that the CI workflow no longer fails.
Also, all V1 commands used in the documentation have been changed to V2 commands.

Any background context you want to provide?

This issue is caused by ubuntu images in the actions runner no longer supporting docker compose V1.
More context is provided in yorkie-team/yorkie#949

What are the relevant tickets?

Fixes #

Checklist

  • Added relevant tests or not required
  • Didn't break anything

Summary by CodeRabbit

  • New Features

    • Updated all documentation to reflect the latest Docker CLI command syntax, transitioning from docker-compose to docker compose for improved clarity and consistency.
  • Documentation

    • Revised instructions in multiple README files and the contributing guide to ensure users are informed of the current best practices for using Docker commands.

@CLAassistant
Copy link

CLAassistant commented Aug 3, 2024

CLA assistant check
All committers have signed the CLA.

Copy link

coderabbitai bot commented Aug 3, 2024

Important

Review skipped

Auto reviews are limited to specific labels.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

The recent changes focus on updating command syntax in various documentation files and CI configurations from docker-compose to the newer docker compose format. This transition aligns with Docker's evolving command-line interface, enhancing clarity and consistency while maintaining the same functionality for building and running services.

Changes

Files Change Summary
.github/workflows/ci.yml, Updated Docker command syntax from docker-compose to docker compose in CI workflow to reflect the latest conventions.
CONTRIBUTING.md, examples/README.md, Transitioned command syntax from docker-compose to docker compose across multiple documentation sections for clarity.
examples/nextjs-scheduler/README.md, Updated command syntax for starting services from docker-compose to docker compose to align with current best practices.
examples/profile-stack/README.md, Changed Docker command syntax to docker compose, promoting modern usage in documentation.
examples/react-tldraw/README.md, Modified command syntax for clarity and consistency in Docker service startup instructions.
examples/react-todomvc/README.md, Updated Docker command syntax in README for Yorkie server startup.
examples/simultaneous-cursors/README.md, Updated to the newer Docker command syntax for launching the Yorkie server.
examples/vanilla-codemirror6/README.md, Changed Docker command syntax from docker-compose to docker compose for clarity.
examples/vanilla-quill/README.md, Updated command syntax to reflect the latest Docker CLI conventions.
examples/vuejs-kanban/README.md Modified command syntax for starting Yorkie server, aligning with current Docker practices.

Poem

🐰 In the land of Docker dreams,
Commands have changed, or so it seems.
From hyphens to spaces, a simpler way,
To spin up containers, hip hip hooray!
Clarity reigns where chaos once played,
Join us, dear friends, in this joyful upgrade! 🎉


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

Outside diff range, codebase verification and nitpick comments (11)
examples/profile-stack/README.md (1)

16-16: Remove the dollar sign before the command.

The dollar sign before the command is unnecessary and should be removed to comply with Markdownlint's MD014 rule.

- $ docker compose -f docker/docker-compose.yml up --build -d
+ docker compose -f docker/docker-compose.yml up --build -d
Tools
Markdownlint

16-16: null
Dollar signs used before commands without showing output

(MD014, commands-show-output)

examples/vuejs-kanban/README.md (1)

16-16: Remove the dollar sign before the command.

The dollar sign before the command is unnecessary and should be removed to comply with Markdownlint's MD014 rule.

- $ docker compose -f docker/docker-compose.yml up --build -d
+ docker compose -f docker/docker-compose.yml up --build -d
Tools
Markdownlint

16-16: null
Dollar signs used before commands without showing output

(MD014, commands-show-output)

examples/vanilla-codemirror6/README.md (1)

16-16: Remove the dollar sign before the command.

The dollar sign before the command is unnecessary and should be removed to comply with Markdownlint's MD014 rule.

- $ docker compose -f docker/docker-compose.yml up --build -d
+ docker compose -f docker/docker-compose.yml up --build -d
Tools
Markdownlint

16-16: null
Dollar signs used before commands without showing output

(MD014, commands-show-output)

examples/react-tldraw/README.md (1)

16-16: Consider removing the dollar sign before the command.

The dollar sign is typically used to indicate a command prompt and can be omitted to avoid confusion, especially in documentation.

-$ docker compose -f docker/docker-compose.yml up --build -d
+docker compose -f docker/docker-compose.yml up --build -d
Tools
Markdownlint

16-16: null
Dollar signs used before commands without showing output

(MD014, commands-show-output)

examples/react-todomvc/README.md (1)

16-16: Consider removing the dollar sign before the command.

The dollar sign is typically used to indicate a command prompt and can be omitted to avoid confusion, especially in documentation.

-$ docker compose -f docker/docker-compose.yml up --build -d
+docker compose -f docker/docker-compose.yml up --build -d
Tools
Markdownlint

16-16: null
Dollar signs used before commands without showing output

(MD014, commands-show-output)

examples/nextjs-scheduler/README.md (1)

16-16: Consider removing the dollar sign before the command.

The dollar sign is typically used to indicate a command prompt and can be omitted to avoid confusion, especially in documentation.

-$ docker compose -f docker/docker-compose.yml up --build -d
+docker compose -f docker/docker-compose.yml up --build -d
Tools
Markdownlint

16-16: null
Dollar signs used before commands without showing output

(MD014, commands-show-output)

examples/simultaneous-cursors/README.md (1)

47-47: Update command syntax and remove dollar sign.

The command syntax has been correctly updated to docker compose. To comply with Markdownlint rules, consider removing the dollar sign before the command.

- $ docker compose -f docker/docker-compose.yml up --build -d
+ docker compose -f docker/docker-compose.yml up --build -d
Tools
Markdownlint

47-47: null
Dollar signs used before commands without showing output

(MD014, commands-show-output)

examples/vanilla-quill/README.md (1)

47-47: Update command syntax and remove dollar sign.

The command syntax has been correctly updated to docker compose. To comply with Markdownlint rules, consider removing the dollar sign before the command.

- $ docker compose -f docker/docker-compose.yml up --build -d
+ docker compose -f docker/docker-compose.yml up --build -d
Tools
Markdownlint

47-47: null
Dollar signs used before commands without showing output

(MD014, commands-show-output)

CONTRIBUTING.md (3)

69-69: Update command syntax and remove dollar sign.

The command syntax has been correctly updated to docker compose. To comply with Markdownlint rules, consider removing the dollar sign before the command.

- $ docker compose -f docker/docker-compose.yml up --build -d
+ docker compose -f docker/docker-compose.yml up --build -d
Tools
Markdownlint

69-69: null
Dollar signs used before commands without showing output

(MD014, commands-show-output)


82-82: Update command syntax and remove dollar sign.

The command syntax has been correctly updated to docker compose. To comply with Markdownlint rules, consider removing the dollar sign before the command.

- $ docker compose -f docker/docker-compose.yml up --build -d
+ docker compose -f docker/docker-compose.yml up --build -d
Tools
Markdownlint

82-82: null
Dollar signs used before commands without showing output

(MD014, commands-show-output)


119-119: Update command syntax and remove dollar sign.

The command syntax has been correctly updated to docker compose. To comply with Markdownlint rules, consider removing the dollar sign before the command.

- $ docker compose -f docker/docker-compose.yml up --build -d
+ docker compose -f docker/docker-compose.yml up --build -d
Tools
Markdownlint

119-119: null
Dollar signs used before commands without showing output

(MD014, commands-show-output)

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 83a6369 and ec0b1f5.

Files selected for processing (11)
  • .github/workflows/ci.yml (1 hunks)
  • CONTRIBUTING.md (3 hunks)
  • examples/README.md (1 hunks)
  • examples/nextjs-scheduler/README.md (1 hunks)
  • examples/profile-stack/README.md (1 hunks)
  • examples/react-tldraw/README.md (1 hunks)
  • examples/react-todomvc/README.md (1 hunks)
  • examples/simultaneous-cursors/README.md (1 hunks)
  • examples/vanilla-codemirror6/README.md (1 hunks)
  • examples/vanilla-quill/README.md (1 hunks)
  • examples/vuejs-kanban/README.md (1 hunks)
Files skipped from review due to trivial changes (2)
  • .github/workflows/ci.yml
  • examples/README.md
Additional context used
Markdownlint
examples/profile-stack/README.md

16-16: null
Dollar signs used before commands without showing output

(MD014, commands-show-output)

examples/vuejs-kanban/README.md

16-16: null
Dollar signs used before commands without showing output

(MD014, commands-show-output)

examples/vanilla-codemirror6/README.md

16-16: null
Dollar signs used before commands without showing output

(MD014, commands-show-output)

examples/react-tldraw/README.md

16-16: null
Dollar signs used before commands without showing output

(MD014, commands-show-output)

examples/react-todomvc/README.md

16-16: null
Dollar signs used before commands without showing output

(MD014, commands-show-output)

examples/nextjs-scheduler/README.md

16-16: null
Dollar signs used before commands without showing output

(MD014, commands-show-output)

examples/simultaneous-cursors/README.md

47-47: null
Dollar signs used before commands without showing output

(MD014, commands-show-output)

examples/vanilla-quill/README.md

47-47: null
Dollar signs used before commands without showing output

(MD014, commands-show-output)

CONTRIBUTING.md

69-69: null
Dollar signs used before commands without showing output

(MD014, commands-show-output)


82-82: null
Dollar signs used before commands without showing output

(MD014, commands-show-output)


119-119: null
Dollar signs used before commands without showing output

(MD014, commands-show-output)

@krapie krapie self-requested a review August 4, 2024 03:31
@krapie krapie added the enhancement 🌟 New feature or request label Aug 4, 2024
Copy link
Member

@krapie krapie left a comment

Choose a reason for hiding this comment

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

LGTM.

@krapie krapie merged commit 3e6d0b2 into yorkie-team:main Aug 4, 2024
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement 🌟 New feature or request
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

3 participants