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

chore(ci): binaries build continue-on-error when release #6865

Conversation

leet4tari
Copy link
Contributor

@leet4tari leet4tari commented Mar 10, 2025

Description
continue-on-error when release or set in build matrix, else defaults to false

Motivation and Context
Make release happen no matter build status

Summary by CodeRabbit

  • Chores
    • Improved build reliability with refined error handling in critical release workflows.
    • Optimized build configurations to support smoother file operations during compilation.

@leet4tari leet4tari requested a review from a team as a code owner March 10, 2025 09:49
Copy link
Contributor

coderabbitai bot commented Mar 10, 2025

Walkthrough

The changes update the GitHub Actions workflow for building binaries. The workflow now sets a new environment variable (RUSTUP_PERMIT_COPY_RENAME: true) and refines the error handling logic in the builds job. The new error condition checks if the current Git reference is a tag or if the build is marked as a best effort, altering how the build handles errors during execution.

Changes

File Change Summary
.github/workflows/build_binaries.yml - Added environment variable: RUSTUP_PERMIT_COPY_RENAME: true
- Updated continue-on-error condition from using `matrix.builds.best_effort

Sequence Diagram(s)

sequenceDiagram
    participant W as Workflow Runner
    participant B as Builds Job
    participant C as Condition Evaluator

    W->>B: Trigger build process
    B->>C: Evaluate `continue-on-error` condition
    C-->>B: Check if `github.ref` starts with "refs/tags/" or `matrix.best_effort` is true
    alt Condition Met
        B->>W: Continue build (allow errors)
    else Condition Not Met
        B->>W: Fail build on errors
    end
Loading

Suggested reviewers

  • SWvheerden

Poem

I'm a rabbit with a grin so wide,
Hopping through code on a joyful ride.
New flags gleam like dewdrops bright,
Error checks shine in the build light.
With whiskers twitching in pure delight, 🐰
I cheer for changes that feel just right!
Hop along and code into the night!


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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 generate docstrings to generate docstrings for this 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.

@leet4tari leet4tari changed the title chore(ci): binaries build continue-on-error when release or set in build matrix, else defaults to false chore(ci): binaries build continue-on-error when release Mar 10, 2025
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

🧹 Nitpick comments (1)
.github/workflows/build_binaries.yml (1)

41-41: New Environment Variable Addition

The addition of RUSTUP_PERMIT_COPY_RENAME: true on line 41 clearly documents that the Rust toolchain is being granted permission to perform copy/rename operations—likely to work around issues seen during the build. Please ensure that this change is accompanied by internal documentation or comments explaining why this flag was introduced and under which circumstances it is needed.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between d948613 and 93d8239.

📒 Files selected for processing (1)
  • .github/workflows/build_binaries.yml (2 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (6)
  • GitHub Check: test (mainnet, stagenet)
  • GitHub Check: test (nextnet, nextnet)
  • GitHub Check: cargo check with stable
  • GitHub Check: Cucumber tests / FFI
  • GitHub Check: ci
  • GitHub Check: Cucumber tests / Base Layer
🔇 Additional comments (1)
.github/workflows/build_binaries.yml (1)

100-100: Refined Continue-On-Error Condition

The updated expression for the continue-on-error property now evaluates to true if the build is triggered by a tag (indicating a release) or if the build matrix explicitly sets best_effort to true. This refinement aligns with the PR objective of allowing release builds or explicitly-marked best-effort builds to proceed even on errors, while defaulting to a strict failure in other cases.
Please verify that:

  • The condition correctly distinguishes release builds via startsWith(github.ref, 'refs/tags/').
  • matrix.builds.best_effort is reliably set in the build matrix when you expect a best effort build.
    Overall, the logic appears clear and appropriate for the intended behavior.

Copy link

Test Results (CI)

    3 files    129 suites   35m 43s ⏱️
1 361 tests 1 361 ✅ 0 💤 0 ❌
4 081 runs  4 081 ✅ 0 💤 0 ❌

Results for commit 93d8239.

Copy link

Test Results (Integration tests)

 2 files  11 suites   30m 10s ⏱️
36 tests 35 ✅ 0 💤 1 ❌
37 runs  36 ✅ 0 💤 1 ❌

For more details on these failures, see this check.

Results for commit 93d8239.

@SWvheerden SWvheerden merged commit d86d6af into tari-project:development Mar 10, 2025
16 of 18 checks passed
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.

2 participants