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: set fail-fast on job #2530

Merged
merged 1 commit into from
Jul 22, 2024
Merged

ci: set fail-fast on job #2530

merged 1 commit into from
Jul 22, 2024

Conversation

gartnera
Copy link
Member

@gartnera gartnera commented Jul 22, 2024

Description

Setting fail-fast on the matrix is not working, let's try setting it on the job too. Correct behavior is that matrix jobs are not cancelled if one fails. For the nightly runs, we want to see exactly what failed.

image

https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstrategyfail-fast

Summary by CodeRabbit

  • Enhancements
    • Improved CI/CD pipeline behavior to allow continuation of job executions even if one job fails, enabling more comprehensive testing and feedback.

@gartnera gartnera added the no-changelog Skip changelog CI check label Jul 22, 2024
Copy link
Contributor

coderabbitai bot commented Jul 22, 2024

Important

Review skipped

Auto incremental reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

Walkthrough

The recent modification to the GitHub Actions workflow introduces a new strategy option in the job configuration, specifically setting fail-fast to false. This change enhances the control flow of the CI/CD pipeline, allowing for continued execution of jobs even if one fails. As a result, the workflow can provide more comprehensive testing and feedback, improving overall reliability and insight into failures during the continuous integration process.

Changes

Files Change Summary
.github/workflows/reusable-e2e.yml Added strategy with fail-fast: false to allow jobs to continue executing despite failures.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant CI/CD Pipeline
    participant Job A
    participant Job B
    participant Job C

    User->>CI/CD Pipeline: Start Workflow
    CI/CD Pipeline->>Job A: Execute Job A
    alt Job A Fails
        Job A-->>CI/CD Pipeline: Fail
    else Job A Succeeds
        Job A-->>CI/CD Pipeline: Success
    end
    CI/CD Pipeline->>Job B: Execute Job B
    CI/CD Pipeline->>Job C: Execute Job C
Loading

This diagram illustrates the interaction flow in the CI/CD process before and after introducing the fail-fast: false strategy, allowing subsequent jobs to execute regardless of the outcome of Job A.


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>.
    • 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 as 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.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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.

@github-actions github-actions bot added the ci Changes to CI pipeline or github actions label Jul 22, 2024
@gartnera gartnera changed the title ci: move strategy from matrix to job ci: set fail-fast on job too Jul 22, 2024
@gartnera gartnera marked this pull request as ready for review July 22, 2024 16:46
@gartnera gartnera requested a review from a team as a code owner July 22, 2024 16:46
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

Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between df6ff86 and 524a968.

Files selected for processing (1)
  • .github/workflows/reusable-e2e.yml (1 hunks)
Additional comments not posted (1)
.github/workflows/reusable-e2e.yml (1)

28-29: Correctly Implemented fail-fast Strategy at Job Level

The addition of the strategy key with fail-fast set to false ensures that the workflow continues executing other jobs even if one fails. This aligns with the objective of providing more comprehensive testing and feedback.

@gartnera gartnera changed the title ci: set fail-fast on job too ci: set fail-fast on job Jul 22, 2024
@gartnera gartnera added the UPGRADE_LIGHT_TESTS Run make start-upgrade-test-light label Jul 22, 2024
@gartnera gartnera force-pushed the fix-nightly-cancel branch 3 times, most recently from 77e9eb9 to 524a968 Compare July 22, 2024 19:15
@gartnera gartnera enabled auto-merge July 22, 2024 19:21
Copy link

codecov bot commented Jul 22, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 46.90%. Comparing base (df6ff86) to head (524a968).
Report is 2 commits behind head on develop.

Additional details and impacted files

Impacted file tree graph

@@             Coverage Diff             @@
##           develop    #2530      +/-   ##
===========================================
+ Coverage    46.50%   46.90%   +0.40%     
===========================================
  Files          456      460       +4     
  Lines        30282    31261     +979     
===========================================
+ Hits         14083    14664     +581     
- Misses       15372    15743     +371     
- Partials       827      854      +27     

see 15 files with indirect coverage changes

@gartnera gartnera added this pull request to the merge queue Jul 22, 2024
Merged via the queue into develop with commit f52da7c Jul 22, 2024
61 checks passed
@gartnera gartnera deleted the fix-nightly-cancel branch July 22, 2024 20:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ci Changes to CI pipeline or github actions no-changelog Skip changelog CI check UPGRADE_LIGHT_TESTS Run make start-upgrade-test-light
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants