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

[ENH] Add docker image build for arm64 architecture #429

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

surchs
Copy link
Contributor

@surchs surchs commented Feb 6, 2025

Changes proposed in this pull request:

  • enable building CLI docker image for arm64 architecture

note: we confirmed that the new arm images are runnable on an arm mac by pulling, running and getting the help menu to show.

Checklist

This section is for the PR reviewer

  • PR has an interpretable title with a prefix ([ENH], [FIX], [REF], [TST], [CI], [MNT], [INF], [MODEL], [DOC]) (see our Contributing Guidelines for more info)
  • PR has a label for the release changelog or skip-release (to be applied by maintainers only)
  • PR links to GitHub issue with mention Closes #XXXX
  • Tests pass
  • Checks pass

For new features:

  • Tests have been added

For bug fixes:

  • There is at least one test that would fail under the original bug conditions.

Summary by Sourcery

Enable building and pushing of CLI Docker images for both arm64 and amd64 architectures in the CI workflow, and add a verification step to ensure the image runs correctly.

Build:

  • Enable building CLI Docker image for arm64 architecture.

CI:

  • Update CI workflow to build and push Docker images for both arm64 and amd64 platforms.
  • Add a step in the CI workflow to run the CLI help command to verify the Docker image.

@surchs surchs added release Create a release when this PR is merged pr-internal Non-user-facing code improvement, will increment patch version when merged (0.0.+1) labels Feb 6, 2025
Copy link

sourcery-ai bot commented Feb 6, 2025

Reviewer's Guide by Sourcery

This PR updates the docker build workflow to support ARM64 architecture alongside AMD64. The changes are implemented by modifying the build configuration, adding platform specifications for the docker build, and including a testing step that runs the CLI help command on the built image.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change Details Files
Updated docker build workflow for multi-architecture support
  • Specified multiple platforms (linux/arm64, linux/amd64) in the build-push-action step.
  • Added a new step to run the CLI help command to validate the built image.
.github/workflows/build_docker_nightly.yml

Assessment against linked issues

Issue Objective Addressed Explanation
#428 Build and publish Docker images for arm64 architecture to support running CLI on arm-based Macs
#428 Ensure the CLI docker images are runnable on recent arm-based Macs

Possibly linked issues


Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!
  • Generate a plan of action for an issue: Comment @sourcery-ai plan on
    an issue to generate a plan of action for it.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link

codecov bot commented Feb 6, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.55%. Comparing base (5a5709c) to head (66413e7).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #429   +/-   ##
=======================================
  Coverage   98.55%   98.55%           
=======================================
  Files          18       18           
  Lines        1109     1109           
=======================================
  Hits         1093     1093           
  Misses         16       16           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@surchs surchs changed the title [ENH] Build [ENH] Add docker image build for arm64 architecture Feb 6, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
pr-internal Non-user-facing code improvement, will increment patch version when merged (0.0.+1) release Create a release when this PR is merged
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Cannot run CLI on Arm (e.g. Mac)
2 participants