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-twobittofa to 472 #51654

Merged
merged 1 commit into from
Oct 25, 2024
Merged

Update ucsc-twobittofa to 472 #51654

merged 1 commit into from
Oct 25, 2024

Conversation

mencian
Copy link
Contributor

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

📝 Walkthrough

Walkthrough

The pull request introduces several modifications across multiple files related to the ucsc-twobittofa package. Notably, the build.sh script has been updated to enhance the CXXFLAGS variable by adding the -O3 optimization flag, improving the compilation process for C++ files. The handling of the twoBitToFa binary has also been revised, changing the order of commands to set permissions before moving the binary to the target directory. Additionally, a file htmshell.c has been deleted, simplifying the logic for handling HTTP responses by removing a condition that required both format and args to be non-null. The include.macos.patch has been introduced, modifying include paths in the common.mk and makefile, and updating the shebang line in a script for broader Python compatibility. The meta.yaml file has been updated to reflect a new version and SHA256 checksum, along with changes to patch handling, requirements, and documentation URLs.

Possibly related PRs

  • Update hictk to v2.0.0 #50881: Changes in build.sh regarding CXXFLAGS and build process improvements are related to the main PR's modifications to CXXFLAGS in build.sh.
  • bambamc: add aarch64/arm64 builds #51067: Updates to build.sh that enhance build behavior and include CXXFLAGS modifications are relevant to the main PR's changes in the same variable.
  • Rebuild breseq #51221: Changes in build.sh that include setting CXXFLAGS and optimizing the build process are similar to the modifications made in the main PR.
  • Update bbmap to 39.10 #51280: Updates to the meta.yaml file and build scripts that involve CXXFLAGS and build configurations are related to the changes in the main PR.
  • Update diamond recipe #51515: Modifications to build.sh that streamline the build process and involve CXXFLAGS are relevant to the main PR's changes.
  • Rebuild Augustus recipe #51641: Updates to CXXFLAGS and build configurations in build.sh are directly related to the changes made in the main PR.

Suggested labels

new version, please review & merge


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 (2)
recipes/ucsc-twobittofa/build.sh (1)

20-21: LGTM: Proper executable handling.

The change to set permissions before moving the binary is correct. The chmod 755 ensures proper executable permissions (rwxr-xr-x).

Consider adding error checking for the binary operations:

-chmod 0755 bin/twoBitToFa
-mv bin/twoBitToFa "${PREFIX}/bin"
+if [ -f bin/twoBitToFa ]; then
+    chmod 0755 bin/twoBitToFa
+    mv bin/twoBitToFa "${PREFIX}/bin"
+else
+    echo "Error: twoBitToFa binary not found"
+    exit 1
+fi
recipes/ucsc-twobittofa/include.macos.patch (1)

1-27: Consider generalizing the include path modifications

While this patch is named include.macos.patch, the modifications to include paths are generally beneficial for all platforms. Consider:

  1. Making these changes part of the main build system rather than a macOS-specific patch
  2. Using a more generic patch name if these changes are indeed needed for all platforms
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 63387fd and 1a297be.

📒 Files selected for processing (4)
  • recipes/ucsc-twobittofa/build.sh (1 hunks)
  • recipes/ucsc-twobittofa/htmshell.patch (0 hunks)
  • recipes/ucsc-twobittofa/include.macos.patch (1 hunks)
  • recipes/ucsc-twobittofa/meta.yaml (3 hunks)
💤 Files with no reviewable changes (1)
  • recipes/ucsc-twobittofa/htmshell.patch
🔇 Additional comments (9)
recipes/ucsc-twobittofa/build.sh (1)

12-12: LGTM: Optimization flag addition matches CFLAGS.

The addition of -O3 optimization flag to CXXFLAGS is consistent with the existing CFLAGS configuration, which should improve runtime performance.

Let's verify the optimization flags are consistently applied:

✅ Verification successful

Let me gather more information to verify the optimization flags across both CFLAGS and CXXFLAGS:


Optimization flags are consistently applied in both CFLAGS and CXXFLAGS

The verification confirms that -O3 optimization level is consistently set for both C and C++ compilation flags, with CXXFLAGS appropriately including the additional include path requirement. This is the correct configuration for optimal performance.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Check if optimization flags are consistently used across make commands
rg "CXXFLAGS.*-O[0-3]" recipes/ucsc-twobittofa/

Length of output: 147


Script:

#!/bin/bash
# Check both CFLAGS and CXXFLAGS settings in the build script
rg "^export C(XX)?FLAGS.*=.*" recipes/ucsc-twobittofa/

Length of output: 228

recipes/ucsc-twobittofa/include.macos.patch (3)

7-8: LGTM: Standard conda build configuration update

The addition of ${PREFIX}/include to HG_INC is the correct approach for conda packages, ensuring that headers from the conda environment are properly located during build.


15-16: LGTM: Consistent include path configuration

The modification to KENT_INC maintains consistency with the global build configuration, properly integrating with the conda build environment.


23-24: Verify Python 3 compatibility of the script

The shebang change from python2.7 to python suggests this script will now run with any Python version. This could lead to compatibility issues if the script contains Python 2-specific code.

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

31-31: LGTM! Appropriate addition of clangdev for macOS builds.

The addition of clangdev as a host requirement for macOS is correct and follows Bioconda's best practices for C/C++ packages.


Line range hint 19-21: Verify run_exports pinning strategy.

The run_exports section uses max_pin=None, which means no automatic version constraints will be added to downstream dependencies. Given that this is a binary package, consider if version pinning would be beneficial to prevent potential ABI incompatibilities.

#!/bin/bash
# Description: Check if other UCSC tools use version pinning
rg -l "run_exports" recipes/ucsc-**/meta.yaml

45-45: Verify the versioned documentation URL.

The changes to the documentation URLs are good improvements:

  • Removed trailing slash from home URL
  • Added proper punctuation to summary
  • Using versioned documentation path
#!/bin/bash
# Description: Verify if the versioned README exists
# Test the documentation URL
curl -s -I "https://github.com/ucscGenomeBrowser/kent/blob/master/v472_base/README" | head -n 1

Also applies to: 47-47, 49-49


14-15: Verify the existence of both patch files.

✅ Verification successful

Both patch files exist and are properly configured

The verification confirms that both patch files are present in the recipe directory:

  • include.patch (1241 bytes) for Linux systems
  • include.macos.patch (1223 bytes) for macOS systems
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check if both patch files exist in the recipe directory
fd "include.*\.patch$" recipes/ucsc-twobittofa/

Length of output: 18690


Script:

#!/bin/bash
# Let's check if the patch files exist in the recipe directory
ls -la recipes/ucsc-twobittofa/include*.patch

Length of output: 270


3-4: Verify the SHA256 checksum for version 472.

@mencian mencian merged commit d81d0ec into master Oct 25, 2024
7 checks passed
@mencian mencian deleted the ucsc-twobittofa branch October 25, 2024 09:48
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