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

Make CI run on the appropriate branch #2358

Merged
merged 7 commits into from
Jan 25, 2024

Conversation

strickvl
Copy link
Contributor

@strickvl strickvl commented Jan 24, 2024

Slow CI was (is currently) only running on main, even if you triggered it with a comment inside a PR. This PR fixes that.

Summary by CodeRabbit

  • Refactor
    • Enhanced the continuous integration process to dynamically handle pull requests, ensuring more robust and efficient testing workflows.

@strickvl strickvl added bug Something isn't working internal To filter out internal PRs and issues labels Jan 24, 2024
Copy link
Contributor

coderabbitai bot commented Jan 24, 2024

Important

Auto Review Skipped

Auto 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.

Walkthrough

The modifications across the GitHub workflow files revolve around enhancing the checkout process. The changes introduce scripts to dynamically obtain pull request details and use this information to checkout code. This allows the workflows to adapt to different PR contexts, potentially improving CI efficiency and accuracy when running tests against the latest code changes.

Changes

File Path Change Summary
.github/workflows/.../ci-slow.yml Replaced static checkout with a script to dynamically fetch PR details and checkout code.
.github/workflows/.../integration-test-slow.yml Added github-script to fetch PR information and updated checkout to use this data.
.github/workflows/.../unit-test.yml Implemented conditional PR detail retrieval and modified checkout to use dynamic repository and ref.

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-tests for this file.
  • 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 tests 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 from git and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit tests.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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 a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

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

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • The JSON schema for the configuration file is available here.
  • 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

@github-actions github-actions bot added the enhancement New feature or request label Jan 24, 2024
@strickvl
Copy link
Contributor Author

@coderabbitai review

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.

Review Status

Actionable comments generated: 0

Configuration used: .coderabbit.yaml

Commits Files that changed from the base of the PR and between a6fef42 and 0c685f2.
Files selected for processing (3)
  • .github/workflows/ci-slow.yml (3 hunks)
  • .github/workflows/integration-test-slow.yml (1 hunks)
  • .github/workflows/unit-test.yml (1 hunks)
Additional comments: 10
.github/workflows/unit-test.yml (2)
  • 76-93: The script added to fetch PR details for non-pull_request events is a good addition. However, ensure that the error handling is robust and that the failure of this step will not cause issues in subsequent steps if the PR details are not required for them.
  • 94-98: The checkout step now dynamically determines the repository and ref to checkout based on the event type. This is a crucial change for ensuring that the CI runs against the correct branch. Verify that this change is tested across different event types to ensure it behaves as expected.
.github/workflows/integration-test-slow.yml (2)
  • 132-147: The addition of the GitHub script to fetch PR details is consistent with the changes in the unit-test.yml file. Ensure that the error handling is robust and that the failure of this step will not cause issues in subsequent steps if the PR details are not required for them.
  • 149-151: The checkout step has been updated to use the PR details fetched by the previous step. This is a crucial change for ensuring that the CI runs against the correct branch. Verify that this change is tested across different event types to ensure it behaves as expected.
.github/workflows/ci-slow.yml (6)
  • 62-77: The addition of the GitHub script to fetch PR details is consistent with the changes in the other workflow files. Ensure that the error handling is robust and that the failure of this step will not cause issues in subsequent steps if the PR details are not required for them.
  • 78-81: The checkout step has been updated to use the PR details fetched by the previous step. This is a crucial change for ensuring that the CI runs against the correct branch. Verify that this change is tested across different event types to ensure it behaves as expected.
  • 103-118: The addition of the GitHub script to fetch PR details in the sqlite-db-migration-testing job is consistent with the changes in the other workflow files. Ensure that the error handling is robust and that the failure of this step will not cause issues in subsequent steps if the PR details are not required for them.
  • 119-122: The checkout step in the sqlite-db-migration-testing job has been updated to use the PR details fetched by the previous step. This is a crucial change for ensuring that the CI runs against the correct branch. Verify that this change is tested across different event types to ensure it behaves as expected.
  • 142-157: The addition of the GitHub script to fetch PR details in the small-checks job is consistent with the changes in the other workflow files. Ensure that the error handling is robust and that the failure of this step will not cause issues in subsequent steps if the PR details are not required for them.
  • 158-161: The checkout step in the small-checks job has been updated to use the PR details fetched by the previous step. This is a crucial change for ensuring that the CI runs against the correct branch. Verify that this change is tested across different event types to ensure it behaves as expected.

@strickvl
Copy link
Contributor Author

Copy link
Contributor

@avishniakov avishniakov left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to go

@strickvl strickvl merged commit a1b5caa into develop Jan 25, 2024
24 checks passed
@strickvl strickvl deleted the feature/comment-with-slow-ci-run-details branch January 25, 2024 08:53
stefannica pushed a commit that referenced this pull request Jan 25, 2024
* use the PR branch

* remove comment-driven part

* checkout the correct repo

* add conditional check for comment-driven trigger

* add conditional checks for slow CI

* Remove unused workflow triggers in ci-slow.yml
kabinja pushed a commit to kabinja/zenml that referenced this pull request Jan 29, 2024
* use the PR branch

* remove comment-driven part

* checkout the correct repo

* add conditional check for comment-driven trigger

* add conditional checks for slow CI

* Remove unused workflow triggers in ci-slow.yml
adtygan pushed a commit to adtygan/zenml that referenced this pull request Mar 21, 2024
* use the PR branch

* remove comment-driven part

* checkout the correct repo

* add conditional check for comment-driven trigger

* add conditional checks for slow CI

* Remove unused workflow triggers in ci-slow.yml
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working enhancement New feature or request internal To filter out internal PRs and issues
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants