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

ci: multi-platform docker build #85

Merged
merged 1 commit into from
Feb 7, 2025
Merged

Conversation

WasinWatt
Copy link
Contributor

@WasinWatt WasinWatt commented Feb 7, 2025

Description

Closes: #XXXX


Author Checklist

All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.

I have...

  • included the correct type prefix in the PR title, you can find examples of the prefixes below:
  • confirmed ! in the type prefix if API or client breaking change
  • targeted the correct branch
  • provided a link to the relevant issue or specification
  • reviewed "Files changed" and left comments if necessary
  • included the necessary unit and integration tests
  • updated the relevant documentation or specification, including comments for documenting Go code
  • confirmed all CI checks have passed

Reviewers Checklist

All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.

I have...

  • confirmed the correct type prefix in the PR title
  • confirmed all author checklist items have been addressed
  • reviewed state machine logic, API design and naming, documentation is accurate, tests and test coverage

Summary by CodeRabbit

  • Chores
    • Updated our container deployment workflow to use the latest versions of key automation tools.
    • Enhanced build processes with improved multi-platform support and caching mechanisms.
    • Streamlined workflow configurations for increased reliability and performance during container builds.

@WasinWatt WasinWatt requested a review from a team as a code owner February 7, 2025 07:57
Copy link

coderabbitai bot commented Feb 7, 2025

Walkthrough

The pull request updates the GitHub Actions workflow for Docker. It upgrades several action versions, including checkout, login, metadata, and build-push actions. Additionally, new steps are introduced to set up QEMU and Docker Buildx. The changes also add new parameters for specifying platforms and caching in the build-push action.

Changes

File Change Summary
.github/workflows/docker.yml - Updated actions/checkout from v3 to v4
- Updated docker/login-action from v2 to v3
- Added docker/setup-qemu-action@v3 and docker/setup-buildx-action@v3
- Updated docker/metadata-action from v4 to v5
- Updated docker/build-push-action from v4 to v5 with new parameters for platforms (linux/amd64,linux/arm64) and caching

Sequence Diagram(s)

sequenceDiagram
    participant Runner as GitHub Actions Runner
    participant Checkout as actions/checkout@v4
    participant Login as docker/login-action@v3
    participant QEMU as docker/setup-qemu-action@v3
    participant Buildx as docker/setup-buildx-action@v3
    participant Metadata as docker/metadata-action@v5
    participant BuildPush as docker/build-push-action@v5

    Runner->>Checkout: Checkout code
    Runner->>Login: Perform Docker login
    Runner->>QEMU: Setup QEMU
    Runner->>Buildx: Setup Buildx
    Runner->>Metadata: Generate metadata
    Runner->>BuildPush: Build and push image
Loading

Poem

Hoppin' through workflows with joy so grand,
Upgraded actions are lending a hand.
QEMU and Buildx join the parade,
Code flows smoother with every upgrade.
I'm a cheerful bunny, coding away—hip, hip, hooray!


🪧 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>, please review it.
    • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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 using 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 generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

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

🧹 Nitpick comments (1)
.github/workflows/docker.yml (1)

27-29: Nitpick on Job Identifier Naming.
The job ID and name are defined as "minitiad", yet the image name is "minimove". Consider verifying that this naming is intentional and consistent across your CI/CD configuration to avoid confusion.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 8a0f95c and acf474f.

📒 Files selected for processing (1)
  • .github/workflows/docker.yml (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: Analyze (go)
🔇 Additional comments (6)
.github/workflows/docker.yml (6)

36-36: Upgrade actions/checkout to v4.
The checkout step now uses actions/checkout@v4, which should include performance improvements and enhanced features over v3. Ensure that no breaking changes affect subsequent steps.


39-39: Update docker/login-action to v3.
The login action has been updated to v3 for improved authentication handling. Please verify that the registry login still works as expected with this version upgrade.


45-47: Add QEMU Setup Step.
A new step using docker/setup-qemu-action@v3 has been added for emulating different CPU architectures, which is necessary for multi-platform builds. This addition looks correct; ensure that QEMU is properly configured on the runner.


48-50: Introduce Docker Buildx Setup.
The workflow now includes a step to set up Docker Buildx (using docker/setup-buildx-action@v3), enabling multi-platform builds. Confirm that Buildx is correctly initialized and integrates with your build process.


53-56: Upgrade Metadata Action to v5.
The metadata extraction step has been upgraded to docker/metadata-action@v5. Verify that the image tags and labels produced align with your downstream usage in the build and push steps.


58-67: Enhance Docker Build-Push Configuration.
The build and push step now uses docker/build-push-action@v5 with several improvements:

  • The platforms parameter is set to "linux/amd64,linux/arm64" for multi-platform support.
  • The push parameter conditionally pushes only when the ref is a tag.
  • Caching is enabled via cache-from and cache-to using GitHub Actions internal caching (type=gha) to speed up builds.

Ensure these parameters meet your CI strategy and that the caching behavior is as intended.

Copy link
Contributor

@Vritra4 Vritra4 left a comment

Choose a reason for hiding this comment

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

LGTM

@WasinWatt WasinWatt merged commit abdd98c into main Feb 7, 2025
4 checks passed
@beer-1 beer-1 deleted the feat/support-arm64-docker-image branch February 22, 2025 10:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants