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

Rebuild MaSuRCA recipe #51662

Merged
merged 3 commits into from
Oct 25, 2024
Merged

Rebuild MaSuRCA recipe #51662

merged 3 commits 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>.

@mencian mencian added the aarch64 Related to adding linux-aarch64 support label Oct 25, 2024
Copy link
Contributor

coderabbitai bot commented Oct 25, 2024

📝 Walkthrough

Walkthrough

This pull request introduces several changes across three main files related to the Masurca software installation and build process. In the install.sh script, the autoreconf -if command is added to regenerate configuration files, and the cp command is modified to cp -arf for improved file copying behavior. The build.sh script sees updates to environment variable exports, including the use of double quotes for consistency and changes in optimization flags from -O2 to -O3. The handling of library paths during linking is also adjusted. The meta.yaml file is updated with a new version number, the addition of a patch file, and several new build dependencies, including automake, autoconf, libtool, and pkg-config. Additionally, the formatting of metadata fields is improved, and new fields for development and documentation URLs are added. Overall, these changes enhance the installation and build processes for the Masurca package.

Possibly related PRs

  • Rebuild breseq #51221: The build.sh script in this PR includes the addition of the autoreconf -if command, similar to the changes made in the main PR's install.sh script, which also modifies the build configuration process.
  • Rebuild Augustus recipe #51641: The build.sh script updates the CXXFLAGS to include optimization flags and changes the C++ standard, which aligns with the main PR's focus on enhancing build configurations through similar modifications.

Suggested labels

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.

@mencian mencian removed the aarch64 Related to adding linux-aarch64 support label Oct 25, 2024
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/masurca/0001-install.sh.patch (1)

13-14: Consider simplifying the cp command flags

The change from cp -a to cp -arf adds redundant flags, as -a already implies recursive copying (-r). Additionally, the force flag (-f) might mask potential issues during installation.

Consider keeping just cp -a unless there's a specific reason for the force flag:

-(cd Flye && make && cp -a ../Flye $DEST);
+(cd Flye && make && cp -a ../Flye $DEST);
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 7952dbb and baaff86.

📒 Files selected for processing (3)
  • recipes/masurca/0001-install.sh.patch (1 hunks)
  • recipes/masurca/build.sh (1 hunks)
  • recipes/masurca/meta.yaml (2 hunks)
🧰 Additional context used
🪛 Shellcheck
recipes/masurca/build.sh

[warning] 4-4: BOOST_ROOT appears unused. Verify use (or export if used externally).

(SC2034)

🔇 Additional comments (8)
recipes/masurca/build.sh (3)

5-5: LGTM! Environment variables are properly configured.

The changes improve the build configuration by:

  • Using consistent quoting for all path variables
  • Correctly appending to LDFLAGS instead of overwriting
  • Setting appropriate paths relative to ${PREFIX}

Also applies to: 8-11


7-7: 🛠️ Refactor suggestion

Consider the implications of aggressive optimization.

  1. The change from -O2 to -O3 enables more aggressive optimization. While this might improve performance, it can potentially:

    • Increase build time
    • Cause larger binary size
    • Lead to unexpected behavior in some cases
  2. The -I${PREFIX}/include in CXXFLAGS is redundant since CPATH is already set.

#!/bin/bash
# Check if other bioconda recipes use -O3
echo "Checking optimization levels in other bioconda recipes..."
rg -l "export CXXFLAGS.*-O3" recipes/

Consider these changes:

-export PERL_EXT_LDFLAGS="-shared -O3 -fstack-protector"
+export PERL_EXT_LDFLAGS="-shared -O2 -fstack-protector"
-export CFLAGS="${CFLAGS} -O3 -std=gnu90 ${LDFLAGS}"
+export CFLAGS="${CFLAGS} -O2 -std=gnu90 ${LDFLAGS}"
-export CXXFLAGS="${CXXFLAGS} -O3 -std=c++14 -I${PREFIX}/include ${LDFLAGS}"
+export CXXFLAGS="${CXXFLAGS} -O2 -std=c++14 ${LDFLAGS}"

Also applies to: 12-13


4-4: Verify BOOST_ROOT usage in the build process.

The BOOST_ROOT variable is set but appears to be unused. Let's verify if this is required by the MaSuRCA build system.

🧰 Tools
🪛 Shellcheck

[warning] 4-4: BOOST_ROOT appears unused. Verify use (or export if used externally).

(SC2034)

recipes/masurca/0001-install.sh.patch (1)

9-10: LGTM: Good addition of autoreconf

The addition of autoreconf -if is a good practice when rebuilding packages, as it ensures the build system is properly regenerated with current autotools versions.

recipes/masurca/meta.yaml (4)

25-28: LGTM: Build dependencies align with autotools usage

The addition of autotools-related build dependencies (automake, autoconf, libtool, pkg-config) is appropriate given the use of autoreconf in the installation process.


47-52: LGTM: Improved metadata documentation

The changes enhance the recipe metadata by:

  • Using consistent quoting for URLs
  • Adding development and documentation URLs
  • Specifying a more precise license family (GPL3)

15-15: Consider impact of looser version pinning

The change from max_pin='x.x' to max_pin='x' makes the version constraint less strict. This means downstream packages will accept any minor version updates, which could potentially lead to compatibility issues if there are breaking changes in minor releases.

Also applies to: 18-18


11-12: Verify patch file existence and contents

The addition of the patch file aligns with the new build dependencies. However, let's verify its presence in the repository.

✅ Verification successful

Let me generate additional shell scripts to verify the patch file existence and its contents.


Patch file exists and is properly formatted

The patch file exists and contains valid modifications to the installation script:

  1. Adds autoreconf -if step for proper autotools configuration
  2. Changes cp -a to cp -arf for more reliable file copying

The patch file is present and properly formatted, addressing the concern in the review comment.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Check if the patch file exists and show its contents
if [ -f recipes/masurca/0001-install.sh.patch ]; then
    echo "Patch file exists. Contents:"
    cat recipes/masurca/0001-install.sh.patch
else
    echo "ERROR: Patch file not found!"
fi

Length of output: 322020


Script:

#!/bin/bash
# Check if the patch file exists and show its contents
ls -l recipes/masurca/0001-install.sh.patch
cat recipes/masurca/0001-install.sh.patch

Length of output: 924

@mencian mencian merged commit e455067 into master Oct 25, 2024
7 checks passed
@mencian mencian deleted the masurca branch October 25, 2024 14:11
This was referenced Nov 18, 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.

1 participant