talmolab / sleap

A deep learning framework for multi-animal pose tracking.
https://sleap.ai
Other
435 stars 97 forks source link

Add workflow to test conda packages #1935

Closed roomrys closed 2 months ago

roomrys commented 2 months ago

Description

Previously, we added a workflow in build_ci.yml which builds and installs SLEAP via the PyPI wheel and then runs our unit tests.

In this PR, we add another workflow in build_conda_ci.yml that builds and installs SLEAP through the conda package and then runs our unit tests. Also, I renamed build_ci.yml to build_pypi_ci.yml. I opted not to bundle the conda package build tests with the pypi build tests as they have some non-overlapping triggers (and the conda build is extremely expensive).

However, note that both these workflows use artifact-upload/download between build and test jobs which means that we could download the passing build packages from the provided link in action and use those to upload to conda and PyPI (instead of rebuilding in build.yml and build_manual.yml).


Currently, all package tests fail with:

=========================== short test summary info ============================
FAILED tests/io/test_videowriter.py::test_imageio_video_writer_avi - ModuleNotFoundError: No module named 'imageio_ffmpeg'
FAILED tests/io/test_videowriter.py::test_imageio_video_writer_odd_size - ModuleNotFoundError: No module named 'imageio_ffmpeg'
==== 2 failed, 693 passed, 11 skipped, 5665 warnings in 1074.01s (0:17:54) =====

when we attempt to

>       import imageio_ffmpeg as ffmpeg
E       ModuleNotFoundError: No module named 'imageio_ffmpeg'

. A repo search of develop shows that imageio-ffmpeg was added as a dependency to the environment yamls, but not to the meta yamls that build the conda packages. This PR does not fix this. Instead #1943 fixes this.


Types of changes

Does this address any currently open issues?

Outside contributors checklist

Thank you for contributing to SLEAP!

:heart:

Summary by CodeRabbit

Summary by CodeRabbit

coderabbitai[bot] commented 2 months ago

Walkthrough

The changes introduce a new GitHub Actions workflow for building and testing a Conda package across multiple operating systems. Additionally, the existing PyPI workflow is updated to reflect a more specific focus on PyPI tasks, with minor formatting improvements. These modifications aim to streamline the automation processes related to package building and testing.

Changes

Files Change Summary
.github/workflows/build_conda_ci.yml Introduced a new workflow for automating Conda package building and testing across Windows, Ubuntu, and macOS. Defines build and tests jobs with matrix strategy and conditional steps.
.github/workflows/build_pypi_ci.yml Updated workflow name to "Build PyPI CI (no upload)" and reformatted paths to use double quotes; minor formatting adjustments made for consistency.

Sequence Diagram(s)

sequenceDiagram
    participant Developer
    participant GitHub Actions
    participant Conda Environment
    participant Test Environment

    Developer->>GitHub Actions: Push changes
    GitHub Actions->>Conda Environment: Set up environment
    GitHub Actions->>Conda Environment: Build Conda package
    Conda Environment-->>GitHub Actions: Upload artifacts
    GitHub Actions->>Test Environment: Set up testing environment
    Test Environment-->>GitHub Actions: Run tests

🐇 In fields of green, I hop with glee,
New workflows bloom, as bright as can be!
Conda builds and tests, oh what a sight,
PyPI shines, all polished and bright!
With each little change, our code takes flight,
Hooray for the updates, everything feels right! 🌼


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 - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `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 generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.