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

Update clusty to v1.1.4 #52217

Merged
merged 2 commits into from
Nov 20, 2024
Merged

Update clusty to v1.1.4 #52217

merged 2 commits into from
Nov 20, 2024

Conversation

mencian
Copy link
Contributor

@mencian mencian commented Nov 20, 2024

Describe your pull request here


Please read the guidelines for Bioconda recipes before opening a pull request (PR).

General instructions

  • If this PR adds or updates a recipe, use "Add" or "Update" appropriately as the first word in its title.
  • New recipes not directly relevant to the biological sciences need to be submitted to the conda-forge channel instead of Bioconda.
  • PRs require reviews prior to being merged. Once your PR is passing tests and ready to be merged, please issue the @BiocondaBot please add label command.
  • Please post questions on Gitter or ping @bioconda/core in a comment.

Instructions for avoiding API, ABI, and CLI breakage issues

Conda is able to record and lock (a.k.a. pin) dependency versions used at build time of other recipes.
This way, one can avoid that expectations of a downstream recipe with regards to API, ABI, or CLI are violated by later changes in the recipe.
If not already present in the meta.yaml, make sure to specify run_exports (see here for the rationale and comprehensive explanation).
Add a run_exports section like this:

build:
  run_exports:
    - ...

with ... being one of:

Case run_exports statement
semantic versioning {{ pin_subpackage("myrecipe", max_pin="x") }}
semantic versioning (0.x.x) {{ pin_subpackage("myrecipe", max_pin="x.x") }}
known breakage in minor versions {{ pin_subpackage("myrecipe", max_pin="x.x") }} (in such a case, please add a note that shortly mentions your evidence for that)
known breakage in patch versions {{ pin_subpackage("myrecipe", max_pin="x.x.x") }} (in such a case, please add a note that shortly mentions your evidence for that)
calendar versioning {{ pin_subpackage("myrecipe", max_pin=None) }}

while replacing "myrecipe" with either name if a name|lower variable is defined in your recipe or with the lowercase name of the package in quotes.

Bot commands for PR management

Please use the following BiocondaBot commands:

Everyone has access to the following BiocondaBot commands, which can be given in a comment:

@BiocondaBot please update Merge the master branch into a PR.
@BiocondaBot please add label Add the please review & merge label.
@BiocondaBot please fetch artifacts Post links to CI-built packages/containers.
You can use this to test packages locally.

Note that the @BiocondaBot please merge command is now depreciated. Please just squash and merge instead.

Also, the bot watches for comments from non-members that include @bioconda/<team> and will automatically re-post them to notify the addressed <team>.

Copy link
Contributor

coderabbitai bot commented Nov 20, 2024

📝 Walkthrough
📝 Walkthrough

Walkthrough

The changes in this pull request involve multiple updates to the clusty package's build and metadata configuration. The build.sh script has been revised to remove symbolic links for gcc and g++, eliminate the export PATH line, and introduce a new variable uname_S to determine the system type. The build command has been adjusted to include specific compiler and linker flags for macOS and other systems. Additionally, the installation command now features verbose output and sets permissions for the installed binary.

The makefile has been modified to remove the -static-libgcc flag from the CLINK variable, streamlining the linking process for Darwin systems. The meta.yaml file has been updated to reflect a new version (1.1.4), implement a variable for the package name, and adjust the run_exports section. New dependencies have been added, a test section introduced, and license information updated. Furthermore, links to the development repository and documentation have been included.

Possibly related PRs

  • Update clusty #51126: This PR updates the meta.yaml file for the clusty package, which is directly related to the changes made in the main PR that also modifies the meta.yaml for clusty.
  • Update clusty to 1.1.1. #51183: Similar to Update clusty #51126, this PR updates the version in the meta.yaml file for the clusty package, indicating a direct connection to the main PR's modifications.
  • Update vclust to 1.2.8 #51692: This PR updates the meta.yaml for the vclust package, which includes changes to the build process and linking flags, similar to the updates made in the main PR's build.sh script for clusty.

Suggested labels

please review & merge

Warning

Rate limit exceeded

@mencian has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 3 minutes and 59 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between 684b646 and 7218e88.


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 684b646 and 7218e88.

📒 Files selected for processing (1)
  • recipes/clusty/build.sh (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • recipes/clusty/build.sh

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 (4)
recipes/clusty/build.sh (2)

2-3: Consider using modern shell syntax

The system detection logic is correct, but consider using the modern $() command substitution syntax instead of backticks.

-uname_S=`uname -s 2>/dev/null || echo not`
+uname_S=$(uname -s 2>/dev/null || echo not)

5-6: Quote variables to handle paths with spaces

While the LDFLAGS setup is correct, it's safer to quote variables to handle potential spaces in paths.

-export LDFLAGS="${LDFLAGS} -L${PREFIX}/lib"
+export LDFLAGS="${LDFLAGS} -L'${PREFIX}/lib'"
recipes/clusty/meta.yaml (2)

28-30: Consider enhancing test coverage

While the basic smoke test is good, consider adding more comprehensive tests such as:

  • Verifying help output (clusty --help)
  • Testing with a small sample dataset
  • Checking version output (clusty --version)

46-47: Consider adding source hash

While skipping the hash lint is common with git sources, consider adding a source hash for better reproducibility:

source:
  sha256: <hash>
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between bdd72de and 684b646.

📒 Files selected for processing (3)
  • recipes/clusty/build.sh (1 hunks)
  • recipes/clusty/buildfixes.patch (1 hunks)
  • recipes/clusty/meta.yaml (1 hunks)
🧰 Additional context used
🪛 yamllint
recipes/clusty/meta.yaml

[error] 1-1: syntax error: found character '%' that cannot start any token

(syntax)

🔇 Additional comments (9)
recipes/clusty/build.sh (2)

13-14: LGTM! Installation commands follow best practices

The installation commands properly create the target directory and set appropriate executable permissions (0755) with verbose output for better debugging.


7-11: Verify the platform-specific LEIDEN flag difference

The build command omits LEIDEN=true for Darwin (macOS) systems while including it for others. This difference might lead to inconsistent functionality across platforms.

recipes/clusty/buildfixes.patch (2)

8-10: LGTM! Removal of -static-libgcc aligns with macOS best practices.

The removal of -static-libgcc from the macOS linker flags is correct as static linking of the GCC runtime library is not recommended on macOS and can lead to integration issues. The remaining flags maintain the necessary optimizations and C++17 standard support.


7-13: Verify if this change addresses known issues.

Let's check if this change resolves any existing problems with the package on macOS.

✅ Verification successful

Removal of -static-libgcc on macOS is appropriate

The change is correct and justified for the following reasons:

  • The patch is specifically applied only on macOS ([osx] in meta.yaml)
  • Static linking of libgcc is not typically recommended on macOS and can cause issues
  • The build script already has separate handling for Darwin/macOS builds
  • The change maintains consistency with other platform-specific compilation flags
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check for related issues or discussions about macOS build problems

# Search for related issues in bioconda-recipes
gh issue list -R bioconda/bioconda-recipes --search "clusty macos static-libgcc" --state all

# Search for related pull requests
gh pr list -R bioconda/bioconda-recipes --search "clusty macos static-libgcc" --state all

# Check if there are any existing build logs showing failures related to static-libgcc
gh run list -R bioconda/bioconda-recipes --workflow build-linux --branch "clusty" -L 10

Length of output: 321


Script:

#!/bin/bash
# Let's check for any build-related files or discussions about macOS compilation
# in the repository and related issues

# Search for any Makefile or build-related files mentioning static-libgcc
rg -l "static-libgcc" --type make

# Search for any discussions about macOS compilation issues
rg -i "macos|darwin" --type md

# Check if there are any other Makefiles with similar patterns
fd Makefile --type f --exec grep -l "Darwin" {} \;

# Look for any build logs or documentation
fd -e log -e md -e txt --exec grep -il "static-libgcc" {} \;

Length of output: 550


Script:

#!/bin/bash
# Let's check the specific recipe directory and patch file content

# Check the content of the patch file
cat recipes/clusty/buildfixes.patch

# Look for any meta.yaml or build scripts in the recipe
cat recipes/clusty/meta.yaml 2>/dev/null
cat recipes/clusty/build.sh 2>/dev/null

# Check if there are any similar Darwin/macOS specific build flags in other recipes
rg "ifeq.*Darwin" --type make -A 3

Length of output: 2229

recipes/clusty/meta.yaml (5)

1-6: LGTM! Good use of Jinja2 variables

The package metadata is well-structured with proper use of variables for name and version.

🧰 Tools
🪛 yamllint

[error] 1-1: syntax error: found character '%' that cannot start any token

(syntax)


19-26: LGTM! Build dependencies are appropriate

The added build dependencies (cmake, flex, bison) are appropriate for a C/C++ project that requires parsing capabilities.


33-39: LGTM! Improved metadata quality

Good improvements:

  • Updated to SPDX license identifier
  • Added development and documentation URLs

9-11: Verify the impact of relaxed version pinning

The change from strict pinning (x.x.x) to more relaxed pinning (x) could potentially lead to ABI compatibility issues. According to Bioconda guidelines, this should align with known breakage patterns.


16-17: LGTM! Verify the patch file contents

The macOS-specific patch is correctly configured with conditional selector.

✅ Verification successful

Patch file correctly removes static linking on macOS as intended

The patch file correctly modifies the makefile to remove -static-libgcc flag from macOS build configuration, which is a common requirement for macOS builds. Similar patches exist in other recipes (graphmap, regenie, star, meraculous, mantis) dealing with static linking adjustments, confirming this is a standard practice.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Check the contents of the patch file
cat recipes/clusty/buildfixes.patch

# Look for similar patches in other recipes for reference
fd -g "*.patch" recipes/ --exec grep -l "static-libgcc"

Length of output: 975

@mencian mencian merged commit 5dbad27 into master Nov 20, 2024
6 checks passed
@mencian mencian deleted the clusty branch November 20, 2024 01:40
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