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: Let GH CI skip build targets specified in GH CI settings #6597

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from

Conversation

UdjinM6
Copy link

@UdjinM6 UdjinM6 commented Feb 25, 2025

Issue being fixed or feature implemented

Unfortunately if on Github can't handle regex so a solution implemented for Gitlab (#6591) can't be used as easily here and requires implementing pretty large workarounds, see #6591 (comment). This PR implements an alternative approach where instead of specifying which targets you want to build you'd instead specify targets you don't need, one by one.

What was done?

How Has This Been Tested?

Screenshot 2025-02-26 at 01 27 01

https://github.com/UdjinM6/dash/actions/runs/13532112313

Breaking Changes

Checklist:

  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have added or updated relevant unit/integration/functional/e2e tests
  • I have made corresponding changes to the documentation
  • I have assigned this pull request to a milestone (for repository code-owners and collaborators only)

@UdjinM6 UdjinM6 added this to the 23 milestone Feb 25, 2025
Copy link

coderabbitai bot commented Feb 25, 2025

Walkthrough

The changes update the CI/CD workflow by introducing conditional checks for job execution. Each job now evaluates one or more environment variables before running, which allows skipping jobs based on variable presence. For example, jobs related to building dependencies or source for various environments check if specific SKIP_* variables are empty. Additionally, the configuration removes the FAST_MODE: false environment variable, suggesting a modification in how options are managed. These modifications streamline the control flow in the build process by ensuring that jobs only execute when appropriate conditions are met.


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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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

@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.yml (1)

1-210: Overall CI configuration review.
The modifications introduce clear conditional checks across various jobs using if conditions based on SKIP_* variables. This design allows users to selectively skip build targets, addressing the CI flexibility limitation described in the PR objectives. As a next step, consider updating the CI documentation (or the README) to briefly describe the purpose of these environment variables and how to use them.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between d5e3d46 and d7f816d.

📒 Files selected for processing (1)
  • .github/workflows/build.yml (12 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (4)
  • GitHub Check: arm-linux-build / Build source
  • GitHub Check: win64-build / Build source
  • GitHub Check: x86_64-apple-darwin / Build depends
  • GitHub Check: x86_64-pc-linux-gnu_nowallet / Build depends
🔇 Additional comments (12)
.github/workflows/build.yml (12)

23-23: Validation of arm‑linux job skip condition.
The new condition

if: ${{ vars.SKIP_ARM_LINUX == '' }}

ensures that the arm‑linux dependency job runs only when the SKIP_ARM_LINUX variable is empty (i.e. not explicitly set to skip). This aligns well with the PR objective of letting users opt out of specific build targets.


32-36: Review of linux64 dependency job multi‑flag condition.
The multi‑line condition:

if: |
  vars.SKIP_LINUX64 == '' ||
  vars.SKIP_LINUX64_FUZZ == '' ||
  vars.SKIP_LINUX64_SQLITE == '' ||
  vars.SKIP_LINUX64_UBSAN == ''

ensures that the job runs if any one of these flags is unset. This approach effectively provides granular control over skipping specific build targets.


45-47: Assessment of multiprocess dependency job condition.
The condition:

if: |
  vars.SKIP_LINUX64_MULTIPROCESS == '' ||
  vars.SKIP_LINUX64_TSAN == ''

ensures that the depends-linux64_multiprocess job is executed if either the multiprocess build or the TSAN build is not skipped. Please verify that using the OR operator here fully reflects the intended behavior for shared dependencies between these two build targets.


56-56: Validation of nowallet dependency job skip condition.
The condition

if: ${{ vars.SKIP_LINUX64_NOWALLET == '' }}

is straightforward and correctly ensures that the job executes only when the corresponding skip flag is not set.


65-65: Validation of mac dependency job skip condition.
The condition

if: ${{ vars.SKIP_MAC == '' }}

ensures that the mac dependency job is run only when the SKIP_MAC variable is unset. This is consistent with the approach taken for other platforms.


74-74: Validation of win64 dependency job skip condition.
The condition

if: ${{ vars.SKIP_WIN64 == '' }}

correctly restricts the win64 job to run only when no skip flag is provided, which is in line with the desired behavior.


92-92: Review of linux64 source build skip condition.
The condition

if: ${{ vars.SKIP_LINUX64 == '' }}

ensures that the linux64 source build job is executed only when the SKIP_LINUX64 flag is empty, maintaining consistency with the dependency jobs.


102-102: Review of linux64_fuzz source build condition.
The condition

if: ${{ vars.SKIP_LINUX64_FUZZ == '' }}

appropriately gatekeeps the execution of the fuzz build job, matching the established pattern used in this workflow.


112-112: Review of linux64_multiprocess source build condition.
The condition

if: ${{ vars.SKIP_LINUX64_MULTIPROCESS == '' }}

ensures that the multiprocess source build runs only when it isn’t explicitly skipped. This is clear and consistent with your overall CI strategy.


131-131: Review of linux64_sqlite source build condition.
The condition

if: ${{ vars.SKIP_LINUX64_SQLITE == '' }}

is implemented correctly, so the sqlite build is executed only when the corresponding skip flag is not set.


141-141: Review of linux64_tsan source build condition.
The condition

if: ${{ vars.SKIP_LINUX64_TSAN == '' }}

ensures that the TSAN build job runs only when the SKIP_LINUX64_TSAN variable is empty. This clear gating mechanism matches the intended behavior.


151-151: Review of linux64_ubsan source build condition.
The condition

if: ${{ vars.SKIP_LINUX64_UBSAN == '' }}

maintains consistency with the other target-specific conditions, ensuring that the UBSAN build is executed only when not skipped.

@UdjinM6 UdjinM6 requested review from PastaPastaPasta and kwvg March 4, 2025 16:29
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