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

gh-actions: Remove pre-installed Go binaries that conflict with brew's installs on macOS (fixes #551). #552

Merged
merged 2 commits into from
Oct 4, 2024

Conversation

LinZhihao-723
Copy link
Member

@LinZhihao-723 LinZhihao-723 commented Oct 4, 2024

Description

This PR fixes #551 by removing pre-installed Go binaries. The pre-installed Go binaries prevent brew from installing Go properly. This PR fixes the issue by removing the pre-installed binaries before running brew.

Validation performed

Ensure all workflows passed.

Summary by CodeRabbit

  • Chores
    • Updated build workflow to remove conflicting Go binaries during the build process.

Copy link
Contributor

coderabbitai bot commented Oct 4, 2024

Walkthrough

The pull request modifies the GitHub Actions workflow file .github/workflows/clp-core-build-macos.yaml by adding a command to remove Go binaries from the /usr/local/bin directory. This addition targets binaries that start with "go" to prevent potential conflicts with Homebrew installations during the build process. No other changes to the workflow structure or job definitions were made.

Changes

Files Change Summary
.github/workflows/clp-core-build-macos.yaml Added command rm -f /usr/local/bin/go* to remove Go binaries.

Assessment against linked issues

Objective Addressed Explanation
Prevent conflicts with Go binaries in Homebrew (551)

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

🧹 Outside diff range and nitpick comments (1)
.github/workflows/clp-core-build-macos.yaml (1)

52-52: Approved: Good solution to resolve Go installation conflicts.

The added command rm -f /usr/local/bin/go* effectively addresses the issue of pre-installed Go binaries interfering with Homebrew installation. This change aligns well with the PR objectives and should resolve the brew link failure described in the linked issue.

For improved clarity and maintainability, consider adding a comment explaining the purpose of this specific removal:

# Remove pre-installed Go binaries to avoid conflicts with Homebrew installation
rm -f /usr/local/bin/go*

This addition will help future maintainers understand the rationale behind removing Go binaries.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 54962a0 and d71fb1e.

📒 Files selected for processing (1)
  • .github/workflows/clp-core-build-macos.yaml (1 hunks)

Copy link
Member

@kirkrodrigues kirkrodrigues left a comment

Choose a reason for hiding this comment

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

For the PR title, how about:

gh-actions: Remove pre-installed Go binaries that conflict with brew's installs on macOS (fixes #551).

@LinZhihao-723 LinZhihao-723 changed the title gh-actions: Remove pre-installed Go binaries when building for macOS (fixes #551). gh-actions: Remove pre-installed Go binaries that conflict with brew's installs on macOS (fixes #551). Oct 4, 2024
@LinZhihao-723 LinZhihao-723 merged commit 9202761 into y-scope:main Oct 4, 2024
7 checks passed
gibber9809 pushed a commit to gibber9809/clp that referenced this pull request Oct 25, 2024
jackluo923 pushed a commit to jackluo923/clp that referenced this pull request Dec 4, 2024
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.

GH: macOS build workflow fail.
2 participants