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

fix(.github): mismatch between CPU chip and binary name on macOS #401

Merged
merged 1 commit into from
Dec 3, 2024

Conversation

KeisukeYamashita
Copy link
Owner

@KeisukeYamashita KeisukeYamashita commented Dec 3, 2024

Why

The macos-latest now points to Apple Silicon so the processor and the binary name (x86_64) mismatches.
To fix it, I pinned the x86_64 binary name with the runner that runs the Intel chip.

Ref

Summary by CodeRabbit

  • Chores
    • Updated macOS version specifications in the build workflow for improved clarity and targeting.

@KeisukeYamashita KeisukeYamashita self-assigned this Dec 3, 2024
Copy link

coderabbitai bot commented Dec 3, 2024

Walkthrough

The changes in this pull request focus on updating the matrix configuration for the build job in the .github/workflows/release.yaml file, specifically for macOS environments. The macOS versioning has been refined: the entry for macos-latest is now macos-13 (Intel x86), and macos-14 # beta (Apple Silicon) has been updated to macos-latest (Apple Silicon). These modifications clarify the target environments for building the project, while the overall workflow structure and job steps remain unchanged.

Changes

File Path Change Summary
.github/workflows/release.yaml Updated macOS matrix configuration: changed macos-latest to macos-13 (Intel x86) and macos-14 # beta (Apple Silicon) to macos-latest (Apple Silicon).

Possibly related PRs

  • fix(.github): docker image name without -rs #369: The changes in both PRs involve modifications to the .github/workflows/release.yaml file, specifically related to the configuration of the workflow, although the focus of the changes differs (macOS specifications vs. Docker image naming).

🐰 In the meadow, changes bloom,
MacOS versions now find room.
From latest to specific, we refine,
In the code, our paths align.
With each build, we hop with glee,
A clearer way for all to see! 🌼


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>, 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 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

Choose a reason for hiding this comment

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

[actionlint] reported by reviewdog 🐶
the runner of "actions-rs/toolchain@v1" action is too old to run on GitHub Actions. update the action's version to fix this issue [action]

- uses: actions-rs/toolchain@v1

Copy link

Choose a reason for hiding this comment

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

[actionlint] reported by reviewdog 🐶
the runner of "actions-rs/toolchain@v1" action is too old to run on GitHub Actions. update the action's version to fix this issue [action]

- uses: actions-rs/toolchain@v1

Copy link

Choose a reason for hiding this comment

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

[actionlint] reported by reviewdog 🐶
the runner of "actions-rs/toolchain@v1" action is too old to run on GitHub Actions. update the action's version to fix this issue [action]

- uses: actions-rs/toolchain@v1

@KeisukeYamashita KeisukeYamashita merged commit d6046e7 into main Dec 3, 2024
13 of 14 checks passed
@KeisukeYamashita KeisukeYamashita deleted the fix/macos-cpu-binary-mismatch branch December 3, 2024 10:33
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: 1

🧹 Outside diff range and nitpick comments (1)
.github/workflows/release.yaml (1)

29-35: Consider universal binary support for macOS

Since you're building for both Intel and Apple Silicon on macOS, consider creating universal binaries to simplify distribution and improve user experience.

Benefits of universal binaries:

  1. Single binary distribution for all macOS users
  2. Automatic architecture selection at runtime
  3. Simplified release management

This would require:

  1. Modifying the build process to create universal binaries
  2. Adjusting the artifact naming convention
  3. Updating the release documentation

Would you like assistance in implementing universal binary support?

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 1ebdd8b and 547eff6.

📒 Files selected for processing (1)
  • .github/workflows/release.yaml (1 hunks)
🔇 Additional comments (1)
.github/workflows/release.yaml (1)

29-35: Verify runner architecture guarantees

Please verify that these assumptions hold true:

  1. macos-13 consistently provides an Intel-based runner
  2. macos-latest consistently provides an Apple Silicon runner

Run this script to check the current GitHub Actions documentation for runner specifications:

Comment on lines +29 to 35
- os: macos-13 (Intel x86)
rust_target: x86_64-apple-darwin
ext: ""
args: ""
- os: macos-14 # beta (Apple Silicon)
- os: macos-latest (Apple Silicon)
rust_target: aarch64-apple-darwin
ext: ""
Copy link

Choose a reason for hiding this comment

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

⚠️ Potential issue

Critical: Fix invalid runner syntax in matrix configuration

The current runner specifications contain invalid syntax that will cause workflow failures. GitHub Actions requires exact runner labels without parentheses.

Apply this correction:

-          - os: macos-13 (Intel x86)
+          - os: macos-13  # Intel x86
            rust_target: x86_64-apple-darwin
            ext: ""
            args: ""
-          - os: macos-latest (Apple Silicon)
+          - os: macos-latest  # Apple Silicon
            rust_target: aarch64-apple-darwin
            ext: ""
            args: ""

This change:

  1. Uses the correct runner labels that GitHub Actions expects
  2. Maintains architecture information as comments
  3. Preserves the intended mapping between runners and rust targets
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
- os: macos-13 (Intel x86)
rust_target: x86_64-apple-darwin
ext: ""
args: ""
- os: macos-14 # beta (Apple Silicon)
- os: macos-latest (Apple Silicon)
rust_target: aarch64-apple-darwin
ext: ""
- os: macos-13 # Intel x86
rust_target: x86_64-apple-darwin
ext: ""
args: ""
- os: macos-latest # Apple Silicon
rust_target: aarch64-apple-darwin
ext: ""

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.

1 participant