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 zol to 1.5.0 #51673

Merged
merged 3 commits into from
Oct 25, 2024
Merged

Update zol to 1.5.0 #51673

merged 3 commits into from
Oct 25, 2024

Conversation

BiocondaBot
Copy link
Collaborator

Update zol: 1.4.121.5.0

install with bioconda Conda

Info Link or Description
Recipe recipes/zol (click to view/edit other files)
Summary zol (& fai): large-scale targeted detection and evolutionary investigation of gene clusters.
Home https://github.com/Kalan-Lab/zol
Releases https://github.com/Kalan-Lab/zol/tags
Recipe Maintainer(s) @raufs
Author @Kalan-Lab

This pull request was automatically generated (see docs).

@BiocondaBot BiocondaBot added autobump Automatic Version Update new version labels Oct 25, 2024
Copy link
Contributor

coderabbitai bot commented Oct 25, 2024

📝 Walkthrough
📝 Walkthrough

Walkthrough

The pull request introduces an update to the meta.yaml file for the zol package. The version number is incremented from 1.4.12 to 1.5.0, indicating a new release. Alongside this version change, the source URL has been modified to point to the new version's tarball located at https://github.com/Kalan-Lab/zol/archive/refs/tags/v1.5.0.tar.gz. Additionally, the SHA256 checksum has been updated to e1d0d090a08a26d2ecbb958d398dc47df94ffbaa034265086c7084d1e88cfb2d to ensure integrity verification for the new version's source archive. Two new dependencies, gravis and colour, have been added to the run requirements section. No other modifications were made to the structure or content of the meta.yaml file.

The build.sh script has also been modified to change the compilation commands for C++ programs, incorporating the -Wl,-headerpad_max_install_names linker flag. The output binaries are now directly placed in the ${PREFIX}/bin directory during compilation. An empty export LDFLAGS= line has been added, and the script ensures that the newly compiled binaries have executable permissions set using chmod +x. The rest of the script continues to manage directory setups for database downloads and environment variable configurations.

Possibly related PRs


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)
recipes/zol/meta.yaml (1)

Line range hint 13-14: Consider pinning critical dependencies

The package has extensive bioinformatics dependencies. While the current configuration is functional, consider:

  1. Pinning version ranges for critical dependencies to ensure reproducibility
  2. Adding upper bounds for dependencies known to have breaking changes

For example:

  run:
    - diamond >=2.1.7,<3.0
    - pyhmmer <2.0
    - pandas >=2.0,<3.0

Also applies to: 19-54

🧰 Tools
🪛 yamllint

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

(syntax)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 5d9856f and 95300c0.

📒 Files selected for processing (1)
  • recipes/zol/meta.yaml (1 hunks)
🔇 Additional comments (2)
recipes/zol/meta.yaml (2)

2-2: LGTM: Version update is consistent

The version bump to 1.5.0 matches the PR objectives and follows semantic versioning.


9-10: Verify release availability and checksum

Let's verify that the GitHub release exists and the checksum matches the source tarball.

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

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 69f2da0 and 7606f34.

📒 Files selected for processing (1)
  • recipes/zol/build.sh (1 hunks)

cp zol/njTree.R ${PREFIX}/bin/
cp zol/phyloHeatmap.R ${PREFIX}/bin/
cp zol/salt_gc_vs_ribo_aai.R ${PREFIX}/bin/
export LDFLAGS=
Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue

Avoid clearing LDFLAGS in conda build scripts.

Setting LDFLAGS to empty could override important system-specific linker flags that conda-build provides. This might cause linking issues on some platforms.

Either remove this line or preserve existing flags:

-export LDFLAGS=
+export LDFLAGS="${LDFLAGS} -Wl,-headerpad_max_install_names"
📝 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
export LDFLAGS=
export LDFLAGS="${LDFLAGS} -Wl,-headerpad_max_install_names"

Comment on lines +8 to +10
${CXX} -std=c++11 -Wl,-headerpad_max_install_names -o ${PREFIX}/bin/runRBH src/zol/orthologs/runRBH.cpp
${CXX} -std=c++11 -Wl,-headerpad_max_install_names -o ${PREFIX}/bin/splitDiamondResults src/zol/orthologs/splitDiamondResults.cpp
${CXX} -std=c++11 -Wl,-headerpad_max_install_names -o ${PREFIX}/bin/splitDiamondResultsForFai src/zol/splitDiamondResultsForFai.cpp
Copy link
Contributor

Choose a reason for hiding this comment

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

💡 Codebase verification

Platform-specific linker flags should be handled by conda-forge's compiler configuration

From the meta.yaml, we can see that the package properly uses conda-forge's C++ compiler configuration ({{ compiler('cxx') }}). This means we don't need to manually handle platform-specific flags as conda-forge's compiler infrastructure will handle this automatically.

The source files referenced in build.sh don't exist in the expected locations, suggesting they might be part of the downloaded source archive. Since we can't verify the C++11 requirements in the source code, we should rely on conda-forge's default compiler settings.

  • Remove the macOS-specific -Wl,-headerpad_max_install_names flag and let conda-forge handle platform-specific linking
  • Keep using C++11 as we can't verify if newer features are used in the source code
  • Simplify the build script to use conda-forge's compiler configuration
-${CXX} -std=c++11 -Wl,-headerpad_max_install_names -o ${PREFIX}/bin/runRBH src/zol/orthologs/runRBH.cpp
-${CXX} -std=c++11 -Wl,-headerpad_max_install_names -o ${PREFIX}/bin/splitDiamondResults src/zol/orthologs/splitDiamondResults.cpp
-${CXX} -std=c++11 -Wl,-headerpad_max_install_names -o ${PREFIX}/bin/splitDiamondResultsForFai src/zol/splitDiamondResultsForFai.cpp
+${CXX} -std=c++11 -o ${PREFIX}/bin/runRBH src/zol/orthologs/runRBH.cpp
+${CXX} -std=c++11 -o ${PREFIX}/bin/splitDiamondResults src/zol/orthologs/splitDiamondResults.cpp
+${CXX} -std=c++11 -o ${PREFIX}/bin/splitDiamondResultsForFai src/zol/splitDiamondResultsForFai.cpp
🔗 Analysis chain

Consider cross-platform compatibility for linker flags.

The -Wl,-headerpad_max_install_names flag is specific to macOS and may cause issues on other platforms. Additionally, the hardcoded C++11 standard might be outdated for newer compilers.

Let's verify the compiler requirements in the package metadata:

Consider these improvements:

  1. Make the linker flags conditional based on the platform
  2. Use the conda-forge compiler standards
  3. Consider upgrading to a newer C++ standard

Here's a suggested implementation:

-${CXX} -std=c++11 -Wl,-headerpad_max_install_names -o ${PREFIX}/bin/runRBH src/zol/orthologs/runRBH.cpp
-${CXX} -std=c++11 -Wl,-headerpad_max_install_names -o ${PREFIX}/bin/splitDiamondResults src/zol/orthologs/splitDiamondResults.cpp
-${CXX} -std=c++11 -Wl,-headerpad_max_install_names -o ${PREFIX}/bin/splitDiamondResultsForFai src/zol/splitDiamondResultsForFai.cpp
+# Set platform-specific flags
+LINKER_FLAGS=""
+if [[ "$OSTYPE" == "darwin"* ]]; then
+    LINKER_FLAGS="-Wl,-headerpad_max_install_names"
+fi
+
+# Compile C++ programs
+for prog in runRBH splitDiamondResults splitDiamondResultsForFai; do
+    ${CXX} -std=c++14 ${LINKER_FLAGS} \
+        -o ${PREFIX}/bin/${prog} \
+        src/zol/orthologs/${prog}.cpp
+done
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Check if there are any compiler requirements specified
rg "compiler:" recipes/zol/meta.yaml

Length of output: 36


Script:

#!/bin/bash
# Let's check the entire meta.yaml file to understand build requirements
cat recipes/zol/meta.yaml

# Also check if there are any other build scripts that might set compiler flags
fd "build.*" recipes/zol/

# Let's also check for any C++ source files to understand minimum required features
fd ".+\.cpp$" -x head -n 20 {}

Length of output: 1558


Script:

#!/bin/bash
# Let's check the actual C++ source files content to understand C++11 requirements
rg -l "std::" src/zol/orthologs/runRBH.cpp src/zol/orthologs/splitDiamondResults.cpp src/zol/splitDiamondResultsForFai.cpp || true

# Let's also check if these files exist at the specified paths
fd -t f "runRBH.cpp|splitDiamondResults.cpp|splitDiamondResultsForFai.cpp"

# Check if there are any platform-specific build configurations
rg "OSTYPE|darwin|linux" recipes/zol/

Length of output: 475

@raufs raufs merged commit d792d8e into master Oct 25, 2024
7 checks passed
@raufs raufs deleted the bump/zol branch October 25, 2024 20:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
autobump Automatic Version Update new version
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants