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 GW to v1.1.1 #51426

Merged
merged 24 commits into from
Oct 22, 2024
Merged

Update GW to v1.1.1 #51426

merged 24 commits into from
Oct 22, 2024

Conversation

kcleal
Copy link
Contributor

@kcleal kcleal commented Oct 16, 2024

No description provided.

@kcleal
Copy link
Contributor Author

kcleal commented Oct 16, 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 gw-1.1.1-h68f53fc_0.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-arm64 gw-1.1.1-hc3eed46_0.tar.bz2 repodata.json CircleCI
showYou may also use conda to install:conda install -c https://output.circle-artifacts.com/output/job/83e83254-37e0-4561-8d72-061ad804d0cc/artifacts/0/tmp/artifacts/packages <package name>

Docker image(s) built:

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

Copy link
Contributor

coderabbitai bot commented Oct 16, 2024

📝 Walkthrough
📝 Walkthrough

Walkthrough

The pull request introduces updates to the meta.yaml file for the gw package. Specifically, the version number has been incremented from "1.1.0" to "1.1.1", and the SHA256 checksum has been modified from "dc96521b8252bde02d9cc68bb3cee156c0469889d2783ee72682338d10657892" to "5ac0430d9179d1a48938f24011c329fe807e72aba0c20eb191c566d129115f86". Additionally, several new test commands have been added under the test section: which gw && ls -lh $(which gw), uname -a, and a conditional command that checks if the system is Darwin to execute file $(which gw), otool -L $(which gw), and nm $(which gw). The previous command that generated a test image has been commented out. All other content within the file, including package metadata, source URL, build requirements, and configurations, remains unchanged.

The conda_build_config.yaml file has been modified by commenting out existing entries for MACOSX_DEPLOYMENT_TARGET and MACOSX_SDK_VERSION, as well as commenting out new entries for CFLAGS, CXXFLAGS, and LDFLAGS, which specify the minimum macOS version.

Possibly related PRs

  • Update Earl Grey meta.yaml #51238: The changes in this PR include the addition of a skip directive for macOS compatibility in the meta.yaml file, which is similar to the skip: true directive added in the main PR for the gw package.
  • updated revision and enabled osx build #51176: This PR also includes a skip directive removal for macOS in the meta.yaml file, indicating a similar focus on build configurations across platforms, aligning with the changes made in the main PR.

Suggested labels

autobump, new version


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 9d47114 and a3cff6c.

📒 Files selected for processing (1)
  • recipes/gw/conda_build_config.yaml (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • recipes/gw/conda_build_config.yaml

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

75-77: Consider optimizing test commands

The added test commands are useful for basic verification, but they could be improved:

  1. The ls -lh command alone doesn't provide much context about the package installation.
  2. The which gw and ls -lh $(which gw) commands could be combined for efficiency.

Consider the following suggestions:

- - ls -lh
- - which gw
- - ls -lh $(which gw)
+ - command -v gw >/dev/null 2>&1 || { echo >&2 "gw not found in PATH"; exit 1; }
+ - ls -lh $(command -v gw)
+ - gw --version

These changes will:

  1. Check if gw is in the PATH and exit with an error if it's not.
  2. Show details of the gw executable if found.
  3. Display the version of gw, which is a common practice for verifying correct installation.
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between bd24904 and 82cc2f2.

📒 Files selected for processing (1)
  • recipes/gw/meta.yaml (2 hunks)
🧰 Additional context used
🪛 yamllint
recipes/gw/meta.yaml

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

(syntax)

🔇 Additional comments (1)
recipes/gw/meta.yaml (1)

1-2: LGTM: Version and checksum updated correctly

The version has been correctly updated to 1.1.1, and the SHA256 checksum has been changed accordingly. These changes are consistent with the PR objective to update GW to v1.1.1.

🧰 Tools
🪛 yamllint

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

(syntax)

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

75-79: Approve new test commands and suggest cleanup.

The new test commands provide more comprehensive and efficient checks for the package installation. They verify the executable's presence, inspect its architecture, and check the version, which are all valuable for ensuring correct package deployment.

Consider removing the commented-out line 79 to keep the file clean:

- #- gw hg19 -b https://github.com/kcleal/gw/releases/download/v1.0.0/demo1.bam -r chr8:37047270-37055161 -n > test.png; ls -lh test.png

If this test is no longer needed, it's better to remove it entirely rather than keeping it as a comment.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 67cf319 and 3207241.

📒 Files selected for processing (1)
  • recipes/gw/meta.yaml (2 hunks)
🧰 Additional context used
🪛 yamllint
recipes/gw/meta.yaml

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

(syntax)

🔇 Additional comments (2)
recipes/gw/meta.yaml (2)

1-2: LGTM: Version and SHA256 updates are correct.

The version has been correctly updated to 1.1.1, and the SHA256 checksum has been changed accordingly. These updates are consistent with the PR objective to update GW to v1.1.1.

🧰 Tools
🪛 yamllint

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

(syntax)


Line range hint 1-79: Summary: Approve PR for updating GW to v1.1.1

The changes in this PR successfully update the GW package to version 1.1.1. The key updates include:

  1. Version number and SHA256 checksum have been correctly updated.
  2. New test commands have been added to provide more comprehensive checks for the package installation.

These changes align with the PR objectives and improve the package validation process. The update appears to be correctly implemented and ready for merging.

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

75-78: Improved test commands. Consider keeping the image generation test.

The new test commands provide more comprehensive checks for the installation and functionality of the gw package. These tests are more robust and less likely to fail due to environmental factors.

Consider keeping the image generation test as an optional or extended test. It could be valuable for visual verification. You might want to add it back with a condition or as a separate test step:

- gw --version
- if [[ "${CONDA_BUILD_CROSS_COMPILATION:-}" != "1" ]]; then
    gw hg19 -b https://github.com/kcleal/gw/releases/download/v1.0.0/demo1.bam -r chr8:37047270-37055161 -n > test.png && ls -lh test.png;
  fi

This way, the image generation test will only run when not cross-compiling, avoiding potential issues in certain build environments.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 3207241 and a8c3d12.

📒 Files selected for processing (1)
  • recipes/gw/meta.yaml (2 hunks)
🧰 Additional context used
🪛 yamllint
recipes/gw/meta.yaml

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

(syntax)

🔇 Additional comments (1)
recipes/gw/meta.yaml (1)

1-2: LGTM! Verify SHA256 checksum.

The version update to 1.1.1 is consistent with the PR objective. The SHA256 checksum has been updated accordingly.

To ensure the integrity of the package, please verify the SHA256 checksum using the following script:

🧰 Tools
🪛 yamllint

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

(syntax)

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

75-78: Improved test commands. Consider adding Linux-specific checks.

The new test commands provide more comprehensive checks for the installed package, including binary verification, system information, and version checking. This improves the robustness of the package testing.

Consider adding Linux-specific checks similar to the Darwin-specific ones. This would provide more balanced testing across platforms. Here's a suggested addition:

- if [[ "$(uname)" == "Linux" ]]; then file $(which gw); ldd $(which gw); readelf -d $(which gw); fi

This addition would check the binary type, shared library dependencies, and dynamic section information on Linux systems.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 075f0ce and be6608d.

📒 Files selected for processing (2)
  • recipes/gw/conda_build_config.yaml (1 hunks)
  • recipes/gw/meta.yaml (2 hunks)
🧰 Additional context used
🪛 yamllint
recipes/gw/meta.yaml

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

(syntax)

🔇 Additional comments (6)
recipes/gw/conda_build_config.yaml (4)

1-2: Verify the intention behind updating MACOSX_DEPLOYMENT_TARGET.

The macOS deployment target has been updated from 10.15 to 11. This change increases the minimum macOS version required, which could potentially exclude older macOS versions from running the package.

Please confirm if this change is intentional and necessary. Are there specific features or dependencies in the updated GW package (v1.1.1) that require macOS 11 or later?


4-5: LGTM: MACOSX_SDK_VERSION update is consistent.

The update of MACOSX_SDK_VERSION to "11" is consistent with the change in MACOSX_DEPLOYMENT_TARGET. This alignment ensures that the SDK version matches the minimum deployment target, which is a good practice.


7-12: LGTM: Addition of CFLAGS, CXXFLAGS, and LDFLAGS is consistent but verify necessity.

The addition of CFLAGS, CXXFLAGS, and LDFLAGS with "-mmacosx-version-min=11" is consistent with the updated MACOSX_DEPLOYMENT_TARGET and MACOSX_SDK_VERSION. This ensures that the package is compiled and linked with macOS 11 as the minimum target across all stages of the build process.

However, these changes further emphasize the potential exclusion of older macOS versions. Please confirm that this strict requirement for macOS 11 and later is necessary for the updated GW package (v1.1.1).


1-12: Summary: Consistent update to macOS 11 target, verify compatibility requirements.

The changes in this file consistently update the macOS target to version 11 across all relevant configuration settings (MACOSX_DEPLOYMENT_TARGET, MACOSX_SDK_VERSION, and compiler/linker flags). While these changes are internally consistent and well-structured, they represent a significant shift in the minimum supported macOS version.

Please verify and confirm the following:

  1. The GW package v1.1.1 requires features specific to macOS 11 or later.
  2. The impact of this change on your user base has been considered, especially for users on older macOS versions.
  3. This update aligns with the overall compatibility strategy for the Bioconda project.

If these points are confirmed, the changes are appropriate and can be approved.

recipes/gw/meta.yaml (2)

79-79: Clarify the rationale for commenting out the image generation test.

The previous test command that generated a test image has been commented out. While the new test commands provide good coverage, the image generation test might have been valuable for ensuring the full functionality of the package.

Could you please explain the reasoning behind removing this test? If it's no longer necessary, consider removing it entirely rather than leaving it commented out. If it's still valuable but problematic in some way, we might want to explore alternatives or fixes to keep this functional test in place.


1-2: Version update looks good. Verify the new checksum.

The version update to 1.1.1 is consistent with the PR objective. The SHA256 checksum has been updated accordingly.

To ensure the integrity of the package, please verify that the new SHA256 checksum is correct for the v1.1.1 release. You can run the following command to check:

Compare the output with the checksum in the meta.yaml file.

🧰 Tools
🪛 yamllint

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

(syntax)

@kcleal kcleal marked this pull request as draft October 18, 2024 17:42
@kcleal kcleal marked this pull request as ready for review October 18, 2024 19:47
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/gw/meta.yaml (1)

76-79: Approve new test commands, consider retaining image generation test.

The new test commands are good additions that help verify the package installation and provide useful information about the binary. However, the commented-out image generation test might still be valuable for visual verification of the package functionality.

Consider keeping both the new commands and the image generation test. You could add a condition to run the image generation test only on certain platforms or as an optional extended test.

Example:

- gw --version
- if [[ "$CONDA_BUILD_CROSS_COMPILATION" != "1" ]]; then
    gw hg19 -b https://github.com/kcleal/gw/releases/download/v1.0.0/demo1.bam -r chr8:37047270-37055161 -n > test.png && ls -lh test.png;
  fi
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 566a7ec and 24e20df.

📒 Files selected for processing (1)
  • recipes/gw/meta.yaml (3 hunks)
🧰 Additional context used
🪛 yamllint
recipes/gw/meta.yaml

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

(syntax)

🔇 Additional comments (3)
recipes/gw/meta.yaml (3)

Line range hint 1-94: Overall changes align with PR objective, minor suggestions for improvement.

The changes in this file successfully update the GW package to version 1.1.1, which aligns with the PR objective. The recipe structure remains consistent with Conda packaging best practices, and the new test commands enhance the package verification process.

Summary of suggestions:

  1. Verify the SHA256 checksum of the source tarball.
  2. Consider incrementing the build number to 1.
  3. Clarify the reason for skipping builds on osx and x86_64.
  4. Consider retaining the image generation test alongside the new test commands.

These minor improvements will further enhance the quality and reliability of the package update.


Line range hint 19-19: Consider incrementing build number and clarify skip condition.

  1. The build number is currently set to 0. Consider incrementing it to 1 since this is a new version of the package.

  2. A new skip condition has been added for osx and x86_64. Can you please clarify the reason for skipping the build on this platform? This may affect package availability for some users.

To check if this skip condition aligns with the package's compatibility, please run:

#!/bin/bash
# Description: Check package compatibility information

# Search for any compatibility information in the repository
rg -i 'compatibility|supported.*platform|system.*requirements' --type md

Also applies to: 34-34

🧰 Tools
🪛 yamllint

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

(syntax)


1-2: LGTM! Verify SHA256 checksum.

The version update to 1.1.1 is consistent with the PR objective. The SHA256 checksum has been updated accordingly.

Please run the following script to verify the SHA256 checksum:

🧰 Tools
🪛 yamllint

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

(syntax)

@kcleal
Copy link
Contributor Author

kcleal commented Oct 19, 2024

@BiocondaBot please add label

@BiocondaBot BiocondaBot added the please review & merge set to ask for merge label Oct 19, 2024
MACOSX_SDK_VERSION: # [osx and x86_64]
- "10.15" # [osx and x86_64]

CFLAGS:
- "-mmacosx-version-min=10.15" # [osx and x86_64]
Copy link
Contributor

Choose a reason for hiding this comment

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

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Ah yes, however I would like to try and get osx x64 working again in the future, so left it in for now.

@martin-g martin-g merged commit 09c5347 into bioconda:master Oct 22, 2024
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
please review & merge set to ask for merge
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants