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(gh-macos-build): Check if pkg-config is installed before trying to install it (fixes #610). #611

Merged
merged 1 commit into from
Nov 22, 2024

Conversation

kirkrodrigues
Copy link
Member

@kirkrodrigues kirkrodrigues commented Nov 22, 2024

Description

To fix #610, this PR only installs pkg-config on macOS if it isn't already installed.

Validation performed

clp-core-macos-build workflow now succeeds.

Summary by CodeRabbit

  • New Features
    • Enhanced installation script to conditionally install pkg-config, preventing conflicts in various environments.

Copy link
Contributor

coderabbitai bot commented Nov 22, 2024

Walkthrough

The pull request modifies the install-all.sh script to conditionally install pkg-config. Instead of directly installing pkg-config via Homebrew, the script now checks if it is already installed on the system. If pkg-config is not found, it proceeds to install it, addressing potential conflicts in environments where pkg-config may be installed through other means.

Changes

File Path Change Summary
components/core/tools/scripts/lib_install/macos/install-all.sh Modified to conditionally install pkg-config based on its presence on the system.

Assessment against linked issues

Objective Addressed Explanation
Prevent conflicts with existing pkg-config installations (610)

Possibly related PRs

Suggested reviewers

  • anlowee

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 7d85ad3 and 9ef31d9.

📒 Files selected for processing (1)
  • components/core/tools/scripts/lib_install/macos/install-all.sh (1 hunks)
🔇 Additional comments (2)
components/core/tools/scripts/lib_install/macos/install-all.sh (2)

Line range hint 8-24: LGTM: Appropriate removal of pkg-config from the brew install list

The removal of pkg-config from the main installation list is consistent with the new conditional installation approach.


26-32: LGTM: Robust implementation of conditional pkg-config installation

The implementation effectively addresses the pkg-config installation conflicts while maintaining proper error handling with set -e. The comments clearly explain the rationale for the conditional installation.

Let's verify the error handling behaviour:

✅ Verification successful

Let me verify the error handling behavior further with additional context.


Verified: The conditional pkg-config installation is safe with set -e

The implementation is correct and safe. The script has proper error handling with set -e at the start, and the command -v check is a POSIX-compliant way to test for command existence that won't trigger the error trap. If pkg-config isn't found, the script will proceed with the installation, and if the installation fails, set -e will properly terminate the script.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify that the command check works correctly with set -e

# Test: Check if the script handles the command check properly
# Expected: Should show that command -v doesn't affect set -e
rg -A 2 -B 2 'set -e' components/core/tools/scripts/lib_install/macos/install-all.sh

# Test: Look for similar patterns in other installation scripts
# Expected: May find other opportunities for similar improvements
rg -l 'brew install.*pkg-config' 'components/core/tools/scripts'

Length of output: 273


Script:

#!/bin/bash
# Check the full context around set -e and command check
rg -A 10 -B 2 'set -e' components/core/tools/scripts/lib_install/macos/install-all.sh

# Check if there's any error handling or set +e
rg 'set \+e|set -e' components/core/tools/scripts/lib_install/macos/install-all.sh

Length of output: 315


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.

@kirkrodrigues kirkrodrigues changed the title build(macos): Check if pkg-config is installed before installing it. build(macos): Check if pkg-config is installed before trying to install it (fixes #610). Nov 22, 2024
@kirkrodrigues kirkrodrigues changed the title build(macos): Check if pkg-config is installed before trying to install it (fixes #610). fix(gh-macos-build): Check if pkg-config is installed before trying to install it (fixes #610). Nov 22, 2024
@kirkrodrigues kirkrodrigues merged commit a864e42 into y-scope:main Nov 22, 2024
12 of 13 checks passed
@kirkrodrigues kirkrodrigues deleted the fix-610 branch November 22, 2024 19:07
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 builds are failing due to pkg-config install conflict
2 participants