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

Problem: cross-compiling macos binaries is problematic in recent nixpkgs #1320

Merged
merged 3 commits into from
Feb 19, 2024

Conversation

yihuang
Copy link
Collaborator

@yihuang yihuang commented Feb 19, 2024

Solution:

  • use the github macos-14 arm mac runner to build arm mac binaries

👮🏻👮🏻👮🏻 !!!! REFERENCE THE PROBLEM YOUR ARE SOLVING IN THE PR TITLE AND DESCRIBE YOUR SOLUTION HERE !!!! DO NOT FORGET !!!! 👮🏻👮🏻👮🏻

PR Checklist:

  • Have you read the CONTRIBUTING.md?
  • Does your PR follow the C4 patch requirements?
  • Have you rebased your work on top of the latest master?
  • Have you checked your code compiles? (make)
  • Have you included tests for any non-trivial functionality?
  • Have you checked your code passes the unit tests? (make test)
  • Have you checked your code formatting is correct? (go fmt)
  • Have you checked your basic code style is fine? (golangci-lint run)
  • If you added any dependencies, have you checked they do not contain any known vulnerabilities? (go list -json -m all | nancy sleuth)
  • If your changes affect the client infrastructure, have you run the integration test?
  • If your changes affect public APIs, does your PR follow the C4 evolution of public contracts?
  • If your code changes public APIs, have you incremented the crate version numbers and documented your changes in the CHANGELOG.md?
  • If you are contributing for the first time, please read the agreement in CONTRIBUTING.md now and add a comment to this pull request stating that your PR is in accordance with the Developer's Certificate of Origin.

Thank you for your code, it's appreciated! :)

Summary by CodeRabbit

  • New Features

    • Expanded operating system support in build configurations to include macOS 14.
    • Enhanced release process with dynamic checksum file naming and improved platform-specific settings.
  • Refactor

    • Optimized release script to accurately assign host variables based on build platform, improving support for different architectures.

Solution:
- use the github macos-14 arm mac runner to build arm mac binaries
@yihuang yihuang requested a review from a team as a code owner February 19, 2024 09:16
@yihuang yihuang requested review from mmsqe and thomas-nguy and removed request for a team February 19, 2024 09:16
Copy link
Contributor

coderabbitai bot commented Feb 19, 2024

Walkthrough

The recent updates focus on enhancing cross-platform compatibility and efficiency in build and release workflows. By adding macOS 14 to the build matrix and implementing a matrix strategy for macOS releases, the changes ensure broader support. Furthermore, dynamic checksum naming and refined host variable assignments based on the build platform improve the automation's flexibility and accuracy.

Changes

File Path Change Summary
.github/workflows/.../build.yml Added macos-14 to the OS matrix.
.github/workflows/.../release.yml Introduced matrix strategy for macOS runners, dynamic checksum file naming, and updated environment variable.
scripts/release.sh Adjusted hosts variable assignments for different build_platform values, enhancing platform-specific support.

🐇✨
In the realm of code where the silicon bunnies hop,
A new dawn breaks, and the old barriers drop.
macOS 14 joins the dance, in the matrix, it swirls,
While checksums and hosts align, in a whirl.
🌟🐾
Through the scripts and workflows, the changes weave,
A tapestry of compatibility, they achieve.
🎉🐇

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-tests for this file.
  • 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 tests 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 from git and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit tests.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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 a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • The JSON schema for the configuration file is available here.
  • 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

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.

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 998b28b and 7ff2940.
Files selected for processing (3)
  • .github/workflows/build.yml (1 hunks)
  • .github/workflows/release.yml (2 hunks)
  • scripts/release.sh (1 hunks)
Files skipped from review due to trivial changes (1)
  • .github/workflows/build.yml
Additional comments: 4
scripts/release.sh (2)
  • 40-41: The update to set hosts to "Darwin_x86_64,native" for x86_64-darwin simplifies the build process for this architecture by removing unnecessary targets. This change should streamline the build process for macOS binaries on x86_64 architecture.
  • 42-42: Similarly, setting hosts to "Darwin_arm64,native" for aarch64-darwin focuses the build process on the ARM architecture for macOS, aligning with the PR's objective to improve the compilation of macOS binaries for ARM. This change is well-justified given the context of problematic cross-compiling issues.
.github/workflows/release.yml (2)
  • 51-54: The introduction of a matrix strategy for the release-macos job, including both macos-latest and macos-14 runners, is a significant improvement. This change allows for parallel builds on different macOS versions, enhancing the build process's efficiency and compatibility.
  • 92-96: Dynamically naming the checksum file based on the architecture (checksums-darwin-$(uname -p).txt) is a thoughtful addition. It ensures that the checksum files are easily identifiable and aligns with the PR's goal of making the release process more architecture-aware. However, ensure that downstream processes or scripts that rely on the checksum file names are updated to accommodate this change.

app/app.go Outdated Show resolved Hide resolved
Signed-off-by: yihuang <huang@crypto.com>
@yihuang yihuang enabled auto-merge February 19, 2024 09:51
@yihuang yihuang added this pull request to the merge queue Feb 19, 2024
Merged via the queue into crypto-org-chain:main with commit 185bb08 Feb 19, 2024
42 checks passed
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