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

Add libgff recipe #51706

Merged
merged 2 commits into from
Oct 28, 2024
Merged

Add libgff recipe #51706

merged 2 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

📝 Walkthrough
📝 Walkthrough

Walkthrough

The pull request introduces two significant changes related to the libgff package. First, a new shell script named build.sh is added to the recipes/libgff directory. This script is designed to set up the environment for building the libgff project using CMake. It configures various parameters based on the operating system, particularly handling macOS-specific settings. The script also specifies the source and build directories, installation prefix, build type, compiler, and flags, and finally executes the build and installation process.

Second, a new configuration file called meta.yaml is introduced, which contains essential metadata for the libgff package. This file includes the package's name, version, source URL, SHA256 checksum, build and host requirements, and a test command to verify the installation. Additionally, it provides information such as the project's homepage, license, summary, and supported platforms, specifically linux-aarch64 and osx-arm64.

Possibly related PRs

  • [recipe for pgrc #50973] Add recipe for pgrc: This PR introduces a build.sh script that configures the build environment and compiles the PgRC project, similar to the build.sh script added in the main PR for libgff.
  • [add gfainject #51287] add gfainject: This PR includes a build.sh script that automates the build process for the gfainject package, which is conceptually similar to the new build.sh script introduced in the main PR.
  • [Add ggcat 1.1.0 recipe #51632] Add ggcat 1.1.0 recipe: This PR also introduces a build.sh script for the ggcat package, which shares the same purpose of automating the build process as the script in the main PR.

Suggested labels

please review & merge, osx-arm64, aarch64


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: 3

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 3007540 and 34b7440.

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

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

(syntax)

🔇 Additional comments (2)
recipes/libgff/build.sh (2)

5-9: LGTM: Proper OS-specific CMake configuration

The Darwin-specific CMake configuration is correct and follows best practices by disabling framework and bundle finding, which can cause issues on macOS builds.


1-16: Consider adding build artifact verification

After the build completes, it would be beneficial to verify that essential build artifacts are present.

#!/bin/bash
# Check if the recipe includes test commands in meta.yaml
echo "Checking for test commands in meta.yaml..."
rg "test:" -A 5 recipes/libgff/meta.yaml

# Verify if libgff.a is listed in the test commands
echo "Checking if libgff.a is being tested..."
rg "libgff\.a" recipes/libgff/meta.yaml

-DCMAKE_CXX_FLAGS="${CXXFLAGS}" \
"${CONFIG_ARGS}"

cmake --build build --target install -j "${CPU_COUNT}" -v
Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue

Add error checking for build step

The build command should include error checking to ensure the build process completes successfully.

-cmake --build build --target install -j "${CPU_COUNT}" -v
+if ! cmake --build build --target install -j "${CPU_COUNT}" -v; then
+    echo "Build failed"
+    exit 1
+fi
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
cmake --build build --target install -j "${CPU_COUNT}" -v
if ! cmake --build build --target install -j "${CPU_COUNT}" -v; then
echo "Build failed"
exit 1
fi

Comment on lines +11 to +14
cmake -S . -B build -DCMAKE_INSTALL_PREFIX="${PREFIX}" \
-DCMAKE_BUILD_TYPE=Release -DCMAKE_CXX_COMPILER="${CXX}" \
-DCMAKE_CXX_FLAGS="${CXXFLAGS}" \
"${CONFIG_ARGS}"
Copy link
Contributor

Choose a reason for hiding this comment

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

🛠️ Refactor suggestion

Consider adding additional CMake configuration options

While the basic CMake configuration is correct, consider adding these improvements for better build control:

  • Enable position-independent code (-DCMAKE_POSITION_INDEPENDENT_CODE=ON)
  • Set RPATH handling (-DCMAKE_INSTALL_RPATH_USE_LINK_PATH=TRUE)
 cmake -S . -B build -DCMAKE_INSTALL_PREFIX="${PREFIX}" \
 	-DCMAKE_BUILD_TYPE=Release -DCMAKE_CXX_COMPILER="${CXX}" \
 	-DCMAKE_CXX_FLAGS="${CXXFLAGS}" \
+	-DCMAKE_POSITION_INDEPENDENT_CODE=ON \
+	-DCMAKE_INSTALL_RPATH_USE_LINK_PATH=TRUE \
 	"${CONFIG_ARGS}"
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
cmake -S . -B build -DCMAKE_INSTALL_PREFIX="${PREFIX}" \
-DCMAKE_BUILD_TYPE=Release -DCMAKE_CXX_COMPILER="${CXX}" \
-DCMAKE_CXX_FLAGS="${CXXFLAGS}" \
"${CONFIG_ARGS}"
cmake -S . -B build -DCMAKE_INSTALL_PREFIX="${PREFIX}" \
-DCMAKE_BUILD_TYPE=Release -DCMAKE_CXX_COMPILER="${CXX}" \
-DCMAKE_CXX_FLAGS="${CXXFLAGS}" \
-DCMAKE_POSITION_INDEPENDENT_CODE=ON \
-DCMAKE_INSTALL_RPATH_USE_LINK_PATH=TRUE \
"${CONFIG_ARGS}"

Comment on lines +1 to +3
#!/bin/bash

export M4="${BUILD_PREFIX}/bin/m4"
Copy link
Contributor

Choose a reason for hiding this comment

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

💡 Codebase verification

M4 dependency missing from build requirements

The build script uses M4 macro processor (${BUILD_PREFIX}/bin/m4) but it's not listed as a build requirement in meta.yaml. This needs to be added to prevent potential build failures.

  • Add m4 to the build: section in recipes/libgff/meta.yaml:
requirements:
  build:
    - make
    - cmake
    - {{ compiler('cxx') }}
    - m4  # Required for build process
🔗 Analysis chain

Verify M4 macro processor availability

The script assumes M4 is available in BUILD_PREFIX, but we should verify its presence to prevent build failures.


Let me gather more information about the build requirements to verify if m4 is properly listed as a dependency.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Check if m4 is listed as a build requirement in meta.yaml
rg -l "m4" recipes/libgff/meta.yaml

# Verify the path exists in typical Bioconda builds
if [ ! -f "${BUILD_PREFIX}/bin/m4" ]; then
    echo "Warning: M4 path not found at expected location"
fi

Length of output: 406


Script:

#!/bin/bash
# Check build requirements in meta.yaml
echo "Checking build requirements..."
rg "requirements:" -A 10 recipes/libgff/meta.yaml

# Also check if m4 is mentioned anywhere else in meta.yaml
echo -e "\nChecking for m4 mentions..."
rg "m4" recipes/libgff/meta.yaml

Length of output: 345

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