-
Notifications
You must be signed in to change notification settings - Fork 97
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
Conversation
Important Review skippedAuto reviews are limited to specific labels. Please check the settings in the CodeRabbit UI or the You can disable this status message by setting the WalkthroughThe recent changes focus on updating command syntax in various documentation files and CI configurations from Changes
Poem
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? TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Additionally, you can add CodeRabbit Configuration File (
|
There was a problem hiding this 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 -dTools
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 -dTools
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 -dTools
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 -dTools
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 -dTools
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 -dTools
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 -dTools
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 -dTools
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 -dTools
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 -dTools
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 -dTools
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
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)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM.
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
Summary by CodeRabbit
New Features
docker-compose
todocker compose
for improved clarity and consistency.Documentation