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 breseq #51221

Merged
merged 3 commits into from
Oct 7, 2024
Merged

Rebuild breseq #51221

merged 3 commits into from
Oct 7, 2024

Conversation

mencian
Copy link
Contributor

@mencian mencian commented Oct 7, 2024

Describe your pull request here

Fixes #51177


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 7, 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 17 minutes and 37 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 d37a254 and fcc0683.

📝 Walkthrough
📝 Walkthrough
📝 Walkthrough

Walkthrough

The pull request introduces modifications to two files: recipes/breseq/build.sh and recipes/breseq/meta.yaml. In build.sh, several enhancements were made to the configuration and build process, including the export of environment variables for INCLUDES, LIBPATH, and LDFLAGS, which are set to include paths based on the specified PREFIX. The script now incorporates a call to autoreconf -if to prepare the build system, and the ./configure command has been updated with additional parameters for CXX and CXXFLAGS, specifically adding optimization flags and include paths. The make command remains largely unchanged, utilizing the updated CXXFLAGS.

In meta.yaml, the build number was incremented from 1 to 2, while the version number remained unchanged. The requirements section saw the removal of make and {{ compiler("c") }}, as well as the removal of zlib from the run dependencies. The summary field was reformatted into a multi-line string, a new dev_url field was added pointing to the GitHub repository, and an identifiers field was introduced with multiple entries.

Assessment against linked issues

Objective Addressed Explanation
Increment the build number to resolve runtime crashes (51177)
Ensure compatibility with Apple Silicon (51177) The changes do not explicitly address runtime issues.

Possibly related PRs

  • trnascan-se: add aarch64/arm64 build #50996: The changes in the build.sh script for tRNAscan-SE include the addition of autoreconf -if, which is similar to the modifications made in the build.sh of the main PR, enhancing the build configuration process.
  • infernal: add osx-arm64 build #50997: The build.sh script for infernal has also been updated to include environment variable exports and modifications to the autoreconf command, paralleling the enhancements made in the main PR's build.sh.
  • bambamc: add aarch64/arm64 builds #51067: The build.sh for bambamc includes improvements to the build process, such as copying configuration files, which aligns with the overall theme of enhancing build scripts seen in the main PR.
  • gxf2bed: add aarch64/arm64 builds #51120: The build.sh for gxf2bed has been modified to improve the handling of environment variables and build commands, reflecting similar objectives to those in the main PR.
  • mashmap: add aarch64 build #51161: The build.sh for mashmap has been updated to include debugging and error tracing, which is consistent with the enhancements made in the main PR's build script.

Suggested labels

please review & merge, osx-arm64

Suggested reviewers

  • mbhall88
  • martin-g

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

5-7: Good environment setup, but consider modifying LDFLAGS

The environment variable setup looks good and uses $PREFIX correctly. However, there's a potential issue with LDFLAGS.

Consider modifying the LDFLAGS line to avoid potential duplication:

-export LDFLAGS="${LDFLAGS} -L${PREFIX}/lib"
+export LDFLAGS="-L${PREFIX}/lib ${LDFLAGS}"

This ensures that the new path is prepended rather than appended, which can help avoid potential conflicts or duplications.


9-13: Good configure setup, but consider removing explicit optimization flag

The configure and build setup looks good overall. Running autoreconf before ./configure is a good practice.

Consider removing the -O3 flag from CXXFLAGS:

-	CXXFLAGS="${CXXFLAGS} -O3 -I${PREFIX}/include" \
+	CXXFLAGS="${CXXFLAGS} -I${PREFIX}/include" \

Conda-build often sets its own optimization flags, and explicitly setting -O3 might override those. Letting conda-build handle optimization can lead to more consistent builds across different packages.

recipes/breseq/meta.yaml (1)

46-50: LGTM: Addition of identifiers enhances package metadata.

The new identifiers field improves the discoverability and cross-referencing of the package. This is a valuable addition to the metadata.

Consider adding a brief comment explaining the significance of these identifiers, especially the distinction between the different biotools entries (breseq, breseq_bam2aln, breseq_bam2cov). This would help users understand the various components or versions referenced by these identifiers.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 395683a and 4763f4a.

📒 Files selected for processing (2)
  • recipes/breseq/build.sh (1 hunks)
  • recipes/breseq/meta.yaml (2 hunks)
🧰 Additional context used
🔇 Additional comments (7)
recipes/breseq/build.sh (3)

1-4: LGTM: Good script setup

The script starts with the correct shebang and uses set -eux for strict error handling and debugging, which are good practices for build scripts.


14-14: LGTM: Efficient build process

The make commands are well-structured. Using "${CPU_COUNT}" for parallel building is good for efficiency, and the subsequent make install is appropriate for installing the built package.


1-14: Overall, the build script looks good with minor suggestions for improvement

The script follows good practices for a conda build script, including proper environment setup, use of autoreconf, and efficient make commands. The suggested improvements (modifying LDFLAGS and removing the explicit -O3 flag) are minor and aimed at ensuring better consistency and avoiding potential issues in the conda build environment.

recipes/breseq/meta.yaml (4)

12-12: LGTM: Build number increment is appropriate.

The build number has been correctly incremented from 1 to 2. This is the proper approach when making changes to a package without altering its version number.


37-38: LGTM: Summary reformatting improves readability.

The summary has been reformatted as a multi-line string, which improves readability in the YAML file. The content remains unchanged, which is appropriate.


40-40: LGTM: Addition of dev_url is beneficial.

The new dev_url field, pointing to the GitHub repository, has been added. This is a positive change as it provides users with a direct link to the development repository, following best practices for package metadata.


Line range hint 16-26: Verify removal of C compiler and zlib dependencies.

The C compiler requirement and zlib run dependency have been removed. Please confirm that:

  1. The package no longer requires C compilation.
  2. zlib is not needed at runtime.

These changes could potentially affect the package's functionality or dependencies.

To verify these changes, please run the following script:

@mencian
Copy link
Contributor Author

mencian commented Oct 7, 2024

@BiocondaBot please fetch artifacts

@BiocondaBot
Copy link
Collaborator

Package(s) built are ready for inspection:

Arch Package Zip File / Repodata CI Instructions
linux-64 breseq-0.39.0-hdcf5f25_2.tar.bz2 LinuxArtifacts.zip Azure
showYou may also use conda to install after downloading and extracting the zip file. From the LinuxArtifacts directory: conda install -c ./packages <package name>
osx-64 breseq-0.39.0-h447d7a5_2.tar.bz2 OSXArtifacts.zip Azure
showYou may also use conda to install after downloading and extracting the zip file. From the OSXArtifacts directory: conda install -c ./packages <package name>
osx-arm64 breseq-0.39.0-h6057758_2.tar.bz2 repodata.json CircleCI
showYou may also use conda to install:conda install -c https://output.circle-artifacts.com/output/job/c5335d35-fa1a-4cb8-8cab-b896bebf7ce9/artifacts/0/tmp/artifacts/packages <package name>
linux-aarch64 breseq-0.39.0-h7f4e536_2.tar.bz2 repodata.json CircleCI
showYou may also use conda to install:conda install -c https://output.circle-artifacts.com/output/job/f5261ce8-c5e6-4e62-8879-ce92b26abae7/artifacts/0/tmp/artifacts/packages <package name>

Docker image(s) built:

Package Tag CI Install with docker
breseq 0.39.0--hdcf5f25_2 Azure
showImages for Azure are in the LinuxArtifacts zip file above.gzip -dc LinuxArtifacts/images/breseq:0.39.0--hdcf5f25_2.tar.gz | docker load

@mencian
Copy link
Contributor Author

mencian commented Oct 7, 2024

@jeffreybarrick mind testing the osx binaries to see if you still encounter the Illegal instruction error?

@jeffreybarrick
Copy link
Contributor

Both of these osx binaries work! 😄

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.

breseq v0.39.0 runtime crashes on Apple Silicon
3 participants