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

[OTE-664] Change docker-compose to new syntax #2035

Merged
merged 1 commit into from
Aug 6, 2024
Merged

Conversation

jerryfan01234
Copy link
Contributor

@jerryfan01234 jerryfan01234 commented Aug 5, 2024

Changelist

changed docker-compose to docker compose in makefile

github deprecated v1 docker (actions/runner-images#9557) so docker-compose is no longer recognized during github auto reviews -> liveness test failing

Test Plan

[Describe how this PR was tested (if applicable)]

Author/Reviewer Checklist

  • If this PR has changes that result in a different app state given the same prior state and transaction list, manually add the state-breaking label.
  • If the PR has breaking postgres changes to the indexer add the indexer-postgres-breaking label.
  • If this PR isn't state-breaking but has changes that modify behavior in PrepareProposal or ProcessProposal, manually add the label proposal-breaking.
  • If this PR is one of many that implement a specific feature, manually label them all feature:[feature-name].
  • If you wish to for mergify-bot to automatically create a PR to backport your change to a release branch, manually add the label backport/[branch-name].
  • Manually add any of the following labels: refactor, chore, bug.

Summary by CodeRabbit

  • Chores
    • Updated the Makefile to use docker compose commands for local network management, enhancing clarity and maintainability.
    • Added a new step in the GitHub Actions workflow to prune the Docker system before running benchmarks, optimizing disk space usage.
    • Introduced a similar step in the GitHub Actions workflow for tests, ensuring efficient Docker resource management during CI/CD processes.

Copy link
Contributor

coderabbitai bot commented Aug 5, 2024

Walkthrough

The recent changes enhance the protocol/Makefile by transitioning from docker-compose to the unified docker compose syntax, improving clarity and maintainability without altering functionality. Additionally, GitHub Actions workflows in protocol-benchmark.yml and protocol-test.yml now include steps to prune unused Docker resources, optimizing disk space before running benchmarks and tests. These updates align with current best practices in Docker management.

Changes

Files Change Summary
protocol/Makefile Updated commands from docker-compose to docker compose for local network management targets.
.github/workflows/protocol-benchmark.yml Added a step to prune the Docker system to free up space before running benchmarks.
.github/workflows/protocol-test.yml Added a step to prune the Docker system to free up space before executing tests.

Poem

🐰 In the garden where code does bloom,
A rabbit hops with joy, dispelling gloom.
With docker compose, oh what a sight,
Clarity dances in the soft moonlight.
Commands now sing, a sweet, clear song,
In the world of tools, we all belong! 🌟


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
Contributor

@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

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 340ea7c and 3ef1baf.

Files selected for processing (1)
  • protocol/Makefile (2 hunks)
Files skipped from review due to trivial changes (1)
  • protocol/Makefile

Copy link
Contributor

@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

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 3ef1baf and 59a2836.

Files selected for processing (3)
  • .github/workflows/protocol-benchmark.yml (1 hunks)
  • .github/workflows/protocol-test.yml (1 hunks)
  • protocol/Makefile (2 hunks)
Files skipped from review as they are similar to previous changes (1)
  • protocol/Makefile
Additional comments not posted (2)
.github/workflows/protocol-benchmark.yml (1)

31-33: LGTM! Pruning Docker system is a good practice.

The addition of the step to prune the Docker system before running benchmarks is a good practice to free up disk space and ensure a clean environment.

.github/workflows/protocol-test.yml (1)

108-110: LGTM! Pruning Docker system is a good practice.

The addition of the step to prune the Docker system before starting the localnet is a good practice to free up disk space and ensure a clean environment.

@jerryfan01234 jerryfan01234 changed the title Change docker-compose to new syntax [OTE-664] Change docker-compose to new syntax Aug 5, 2024
Copy link

linear bot commented Aug 5, 2024

@@ -28,6 +28,9 @@ jobs:
uses: actions/setup-go@v3
with:
go-version: 1.22
- name: Prune Docker system to free up space
run: |
docker system prune -a --volumes -f
Copy link
Contributor

Choose a reason for hiding this comment

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

Have you seen CI fail with disk space issues?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yea, the first PR with just the docker compose change actually triggered this, which is why I included prune

@jerryfan01234 jerryfan01234 merged commit 6930857 into main Aug 6, 2024
18 checks passed
@jerryfan01234 jerryfan01234 deleted the update-makefile branch August 6, 2024 14:56
@roy-dydx
Copy link
Contributor

roy-dydx commented Aug 7, 2024

@Mergifyio backport release/protocol/v5.2.x

@roy-dydx
Copy link
Contributor

roy-dydx commented Aug 7, 2024

https://github.com/Mergifyio backport release/protocol/v6.x

Copy link
Contributor

mergify bot commented Aug 7, 2024

backport release/protocol/v5.2.x

✅ Backports have been created

Copy link
Contributor

mergify bot commented Aug 7, 2024

backport release/protocol/v6.x

✅ Backports have been created

mergify bot pushed a commit that referenced this pull request Aug 7, 2024
(cherry picked from commit 6930857)

# Conflicts:
#	.github/workflows/protocol-test.yml
mergify bot pushed a commit that referenced this pull request Aug 7, 2024
roy-dydx pushed a commit that referenced this pull request Aug 7, 2024
roy-dydx added a commit that referenced this pull request Aug 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Development

Successfully merging this pull request may close these issues.

4 participants