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

ci: limit downloaded files in build_docker #4242

Merged

Conversation

njzjz
Copy link
Member

@njzjz njzjz commented Oct 23, 2024

This download-artifact step fails randomly. Limiting the files to download should reduce the possibility of failure.

Summary by CodeRabbit

  • New Features

    • Enhanced artifact downloading patterns for improved specificity in the build process.
    • Expanded artifact access during the PyPI index build.
  • Improvements

    • Maintained job structure and dependencies for consistent build and deployment processes.
    • Defined permissions for critical jobs to ensure secure operations.

This download-artifact step fails randomly. Limiting the files to download should reduce the possibility of failure.

Signed-off-by: Jinzhe Zeng <jinzhe.zeng@rutgers.edu>
Copy link
Contributor

coderabbitai bot commented Oct 23, 2024

📝 Walkthrough

Walkthrough

The changes in the pull request involve modifications to the GitHub Actions workflow in .github/workflows/build_wheel.yml. Key updates include new artifact downloading patterns in the build_docker and build_pypi_index jobs, while maintaining the overall structure and job dependencies. The upload_pypi job's conditional execution based on event types is preserved, and permissions for various jobs are explicitly defined to ensure proper access for deployment actions.

Changes

File Change Summary
.github/workflows/build_wheel.yml - Added new artifact downloading pattern in build_docker job for cibw-*-manylinux_x86_64-cu${{ matrix.cuda_version }}* files.
- Updated build_pypi_index job with a new artifact pattern cibw-*.
- Preserved overall structure, concurrency settings, and job dependencies.
- Maintained conditional execution for upload_pypi job.
- Explicitly defined permissions for upload_pypi and deploy_pyi_index jobs.

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

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between b4701da and 7178d30.

📒 Files selected for processing (1)
  • .github/workflows/build_wheel.yml (2 hunks)
🧰 Additional context used
🔇 Additional comments (1)
.github/workflows/build_wheel.yml (1)

151-152: LGTM! Verify the artifact pattern matches wheel naming convention.

The pattern cibw-*-manylinux_x86_64-cu${{ matrix.cuda_version }}* effectively limits downloads to only the required wheels for each CUDA version. This should help reduce random failures in the download-artifact step.

Let's verify the pattern matches the wheel naming convention:

✅ Verification successful

Let me try a different approach to verify the artifact naming pattern by examining the workflow file and related configuration.


From examining the workflow file, I can now verify the artifact naming pattern. Let me analyze the key findings:

Pattern matches wheel naming convention - Verified

The pattern cibw-*-manylinux_x86_64-cu${{ matrix.cuda_version }}* is correct because:

  1. The workflow shows that artifacts are uploaded with matching names:

    name: cibw-cp${{ matrix.python }}-${{ matrix.platform_id }}-cu${{ matrix.cuda_version }}-${{ strategy.job-index }}
  2. The matrix values align perfectly:

    • CUDA versions are defined as "12.2" and "11.8" in the matrix
    • Platform ID is explicitly set as "manylinux_x86_64"
    • The pattern will correctly match these artifacts
  3. The build_docker job's matrix correctly maps to these artifacts:

    matrix:
      include:
        - variant: ""
          cuda_version: "12"
        - variant: "_cu11"
          cuda_version: "11"
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check if the wheel filenames match the download pattern
# Expected: Wheel filenames should contain "manylinux_x86_64" and "cu{version}"

# Test: List artifacts from a recent successful workflow run
gh api \
  -H "Accept: application/vnd.github+json" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  "/repos/deepmodeling/deepmd-kit/actions/artifacts" \
  --jq '.artifacts[] | select(.name | contains("manylinux_x86_64")) | .name' 

Length of output: 211


Script:

#!/bin/bash
# Check the workflow file for artifact naming patterns and CUDA matrix values
echo "=== Checking workflow file ==="
cat .github/workflows/build_wheel.yml

# Check for any cibuildwheel config that might affect naming
echo -e "\n=== Checking for cibuildwheel config ==="
fd "setup.cfg|pyproject.toml"

# Look for any test or build scripts that might show artifact naming
echo -e "\n=== Checking for build scripts ==="
fd -t f "build|test" -e sh -e py

Length of output: 18018

.github/workflows/build_wheel.yml Show resolved Hide resolved
Copy link

codecov bot commented Oct 23, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 84.55%. Comparing base (b4701da) to head (7178d30).
Report is 7 commits behind head on devel.

Additional details and impacted files
@@           Coverage Diff           @@
##            devel    #4242   +/-   ##
=======================================
  Coverage   84.55%   84.55%           
=======================================
  Files         537      537           
  Lines       51237    51237           
  Branches     3047     3047           
=======================================
  Hits        43324    43324           
  Misses       6965     6965           
  Partials      948      948           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@njzjz njzjz requested review from wanghan-iapcm and iProzd October 23, 2024 10:04
@wanghan-iapcm wanghan-iapcm added this pull request to the merge queue Oct 23, 2024
Merged via the queue into deepmodeling:devel with commit 8e77785 Oct 23, 2024
60 checks passed
njzjz added a commit to njzjz/deepmd-kit that referenced this pull request Nov 15, 2024
This download-artifact step fails randomly. Limiting the files to
download should reduce the possibility of failure.

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->

## Summary by CodeRabbit

- **New Features**
- Enhanced artifact downloading patterns for improved specificity in the
build process.
	- Expanded artifact access during the PyPI index build.

- **Improvements**
- Maintained job structure and dependencies for consistent build and
deployment processes.
	- Defined permissions for critical jobs to ensure secure operations.

<!-- end of auto-generated comment: release notes by coderabbit.ai -->

Signed-off-by: Jinzhe Zeng <jinzhe.zeng@rutgers.edu>
(cherry picked from commit 8e77785)
njzjz added a commit that referenced this pull request Nov 15, 2024
This download-artifact step fails randomly. Limiting the files to
download should reduce the possibility of failure.

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->

## Summary by CodeRabbit

- **New Features**
- Enhanced artifact downloading patterns for improved specificity in the
build process.
	- Expanded artifact access during the PyPI index build.

- **Improvements**
- Maintained job structure and dependencies for consistent build and
deployment processes.
	- Defined permissions for critical jobs to ensure secure operations.

<!-- end of auto-generated comment: release notes by coderabbit.ai -->

Signed-off-by: Jinzhe Zeng <jinzhe.zeng@rutgers.edu>
(cherry picked from commit 8e77785)
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.

3 participants