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 ucsc-pslcdnafilter to 472 #51700

Merged
merged 5 commits into from
Oct 28, 2024
Merged

Update ucsc-pslcdnafilter to 472 #51700

merged 5 commits into from
Oct 28, 2024

Conversation

mencian
Copy link
Contributor

@mencian mencian commented Oct 28, 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 Oct 28, 2024

Warning

Rate limit exceeded

@mencian has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 18 minutes and 12 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

Files that changed from the base of the PR and between 1b56d33 and b23ff54.

📝 Walkthrough
📝 Walkthrough

Walkthrough

The pull request introduces several changes across three files related to the ucsc-pslcdnafilter package. In build.sh, the handling of compiler flags is modified by adding the optimization flag -O3 to the CXXFLAGS variable, enhancing the compilation process. The script also alters the final steps for managing the built executable, changing the order of operations for setting permissions and moving the executable to the target directory. The include.macos.patch file updates the common.mk and makefile to include the ${PREFIX}/include path in the HG_INC and KENT_INC variables, respectively. Additionally, the shebang line of the expMatrixToBarchartBed script is changed to allow compatibility with any Python version. The meta.yaml file reflects a version increment from "469" to "472", updates the SHA256 checksum, modifies the patch list to include a macOS-specific patch, and adjusts dependencies by adding clangdev and removing zlib. Minor updates to URLs in the about section are also included.

Possibly related PRs

  • Update ucsc-twobittofa to 472 #51654: The changes in the main PR regarding the CXXFLAGS variable and the handling of the twoBitToFa binary are directly related to the modifications made in the build.sh of the ucsc-twobittofa recipe, which also updates CXXFLAGS to include the -O3 optimization flag and alters the process for copying the binary.

Suggested labels

new version, please review & merge

Suggested reviewers

  • mencian

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/ucsc-pslcdnafilter/include.macos.patch (1)

1-27: Consider adding CI tests for cross-platform compatibility.

Since these changes are specifically for macOS compatibility, consider adding CI tests to verify the build process works correctly across different platforms (Linux, macOS) to catch potential issues early.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 9a03cf0 and 1b56d33.

📒 Files selected for processing (3)
  • recipes/ucsc-pslcdnafilter/build.sh (2 hunks)
  • recipes/ucsc-pslcdnafilter/include.macos.patch (1 hunks)
  • recipes/ucsc-pslcdnafilter/meta.yaml (3 hunks)
🔇 Additional comments (10)
recipes/ucsc-pslcdnafilter/build.sh (2)

11-11: LGTM: Consistent optimization flags

Adding -O3 to CXXFLAGS matches the optimization level already present in CFLAGS, ensuring consistent compiler optimization across C and C++ code.


21-22: LGTM: Improved executable installation

The two-step process of explicitly setting permissions before moving the executable is a better practice than direct copying because it:

  1. Ensures correct executable permissions (0755)
  2. Uses move operation which is more efficient than copy
recipes/ucsc-pslcdnafilter/include.macos.patch (3)

15-16: LGTM! Consistent include path configuration.

The addition of -I${PREFIX}/include to KENT_INC maintains consistency with the common.mk changes.


23-24: Verify Python 3 compatibility before removing version constraint.

While removing the Python 2.7 dependency is good, we should ensure the script is compatible with Python 3 before making it version-agnostic.

Let's check for potential Python 2/3 compatibility issues:

#!/bin/bash
# Description: Check for common Python 2/3 compatibility issues in the script
# Look for print statements, unicode handling, etc.

# Test: Search for Python 2-specific syntax that might break in Python 3
rg -A 2 "print [^(]|unicode|basestring|raw_input|xrange|\.iteritems\(\)|\.itervalues\(\)|\.iterkeys\(\)" "kent/src/utils/expMatrixToBarchartBed/expMatrixToBarchartBed"

# Test: Look for division operations that might behave differently
rg -A 2 "[^/]/[^/]" "kent/src/utils/expMatrixToBarchartBed/expMatrixToBarchartBed"

7-8: LGTM! Verify header availability in conda-build environment.

The addition of -I${PREFIX}/include to HG_INC is correct and follows Conda packaging guidelines.

Let's verify the headers are available in the conda-build environment:

✅ Verification successful

Addition of ${PREFIX}/include path is correct and verified

The modification is verified to be correct because:

  1. It's a standard pattern used across all UCSC tools in the repository (identical patches exist in ucsc-bigwigsummary, ucsc-blat, ucsc-fatotwobit, etc.)
  2. The package has host dependencies (libpng, mysql-connector-c, zlib, etc.) that require their headers to be found during build
  3. The build.sh already sets up INCLUDE_PATH and CXXFLAGS to use ${PREFIX}/include, making this change consistent with the overall build configuration
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check if critical headers are present in PREFIX/include
# Note: This helps ensure the build will succeed with the new include path

# Test: List header files in ${PREFIX}/include that might be required
fd . "${PREFIX}/include" -t f -e .h -e .hpp

Length of output: 452


Script:

#!/bin/bash
# Let's verify if the patch file exists and examine its content
fd -t f "include.macos.patch" recipes

# Check if there are any header files referenced in the patch
rg -A 2 "\.h" recipes/ucsc-pslcdnafilter/include.macos.patch

# Look for any build-related files that might give us context about required headers
fd -t f "build.sh|meta.yaml" recipes/ucsc-pslcdnafilter

Length of output: 495


Script:

#!/bin/bash
# Let's examine the build.sh and meta.yaml for dependencies that might require headers
cat recipes/ucsc-pslcdnafilter/meta.yaml
cat recipes/ucsc-pslcdnafilter/build.sh

# Check if similar patches exist in other UCSC tools to validate this is a common pattern
head -n 10 recipes/ucsc-*/include.macos.patch

Length of output: 6478

recipes/ucsc-pslcdnafilter/meta.yaml (5)

14-15: LGTM! Platform-specific patches are properly configured.

The patch configuration correctly handles both Linux and macOS platforms using conditional selectors.


Line range hint 19-21: LGTM! Proper version pinning configuration.

The run_exports section correctly uses pin_subpackage with max_pin=None, ensuring exact version matching which helps prevent ABI incompatibilities.


45-46: LGTM! URL improvements and version-specific documentation.

The URL updates are good improvements:

  • Using HTTPS for security
  • Version-specific documentation link ensures accuracy

Also applies to: 54-54


3-4: Verify version compatibility for the significant version bump.

The update from version 469 to 472 is a significant jump. Since this is a bioinformatics tool, we should ensure there are no breaking changes in the tool's interface.


31-37: Verify if zlib is required at runtime.

While zlib is listed as a host dependency, it's not included in the run dependencies. If the tool uses compression functionality, zlib might be needed at runtime.

@mencian mencian merged commit e76dd9f into master Oct 28, 2024
6 checks passed
@mencian mencian deleted the pslcdnafilter branch October 28, 2024 21:25
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