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: skip downstream connector tests if no source code is changed #101

Merged
merged 6 commits into from
Dec 2, 2024

Conversation

aaronsteers
Copy link
Contributor

@aaronsteers aaronsteers commented Dec 2, 2024

Summary by CodeRabbit

  • Chores
    • Enhanced workflow configuration for testing connectors to improve job control flow and logic.
    • Updated comments for clarity regarding concurrency settings and job handling.

@github-actions github-actions bot added the ci label Dec 2, 2024
Copy link
Contributor

coderabbitai bot commented Dec 2, 2024

Warning

Rate limit exceeded

@aaronsteers has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 20 minutes and 31 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between 36c565f and afda1f6.

📝 Walkthrough
📝 Walkthrough
📝 Walkthrough

Walkthrough

The pull request modifies the GitHub Actions workflow for testing connectors, specifically enhancing the logic that determines when to abort jobs. The condition for aborting the connectors_ci job has been refined to check for source code changes and the applicability of cdk_extra. Additionally, comments throughout the workflow have been updated for clarity, particularly concerning concurrency settings and job execution conditions, while maintaining the overall structure of the workflow.

Changes

File Change Summary
.github/workflows/connector-tests.yml Updated abort conditions for connectors_ci job to improve decision-making logic; enhanced comments for clarity.

Possibly related PRs

  • ci: replace faker with hardcoded source #42: The changes in this PR also involve the .github/workflows/connector-tests.yml file, specifically updating the logic for the connectors_ci job, which is directly related to the modifications made in the main PR regarding job conditions and control flow.
  • Feat: Incorporate SDM in CDK and add publish workflow #58: This PR modifies the .github/workflows/connector-tests.yml file as well, adding new connectors and refining the job conditions, which aligns with the enhancements made in the main PR to the control flow and logic for job execution.
  • CI: move SDM image publish to dedicated step #83: This PR introduces a new workflow for publishing SDM images and includes changes to the overall deployment process, which may relate to the broader context of CI/CD workflows that the main PR is enhancing, particularly in terms of job execution logic.

Suggested reviewers

  • aaronsteers
  • ChristoGrab

What do you think about these suggested reviewers? Do they align with your expectations?


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:

‼️ IMPORTANT
Auto-reply has been disabled for this repository in the CodeRabbit settings. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged.

  • 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: 0

🧹 Outside diff range and nitpick comments (3)
.github/workflows/connector-tests.yml (3)

97-97: Consider adding parentheses for better readability?

The condition is logically correct, but could be more readable with parentheses to clearly group the OR conditions, wdyt?

-if: ${{ needs.cdk_changes.outputs['src'] == 'false' || matrix.cdk_extra != 'n/a' && needs.cdk_changes.outputs[matrix.cdk_extra] == 'false' }}
+if: ${{ needs.cdk_changes.outputs['src'] == 'false' || (matrix.cdk_extra != 'n/a' && needs.cdk_changes.outputs[matrix.cdk_extra] == 'false') }}

Line range hint 4-8: Track the TODO about workflow dependencies?

I notice there's a TODO about moving these tests to run after the "PyTest (Fast)" workflow. Would you like me to create a GitHub issue to track this enhancement? This could help with overall CI efficiency.

🧰 Tools
🪛 actionlint (1.7.4)

98-98: shellcheck reported issue in this script: SC2086:info:2:67: Double quote to prevent globbing and word splitting

(shellcheck)


98-98: shellcheck reported issue in this script: SC2086:info:3:28: Double quote to prevent globbing and word splitting

(shellcheck)


Line range hint 112-114: Consider updating the Airbyte CI reference?

The comment suggests this is using a temporary branch for Airbyte CI. Once the changes are released, we should update this reference back to master, right? Would you like me to help track this?

🧰 Tools
🪛 actionlint (1.7.4)

98-98: shellcheck reported issue in this script: SC2086:info:2:67: Double quote to prevent globbing and word splitting

(shellcheck)


98-98: shellcheck reported issue in this script: SC2086:info:3:28: Double quote to prevent globbing and word splitting

(shellcheck)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 0d4bb42 and 36c565f.

📒 Files selected for processing (1)
  • .github/workflows/connector-tests.yml (1 hunks)
🔇 Additional comments (1)
.github/workflows/connector-tests.yml (1)

Line range hint 97-101: Verify the abort condition behavior

The condition looks good and aligns with the PR objective to skip tests when no source code is changed. Let's verify it works as expected for different scenarios.

✅ Verification successful

The previous command didn't provide the workflow runs data, so let's analyze the workflow definition itself to verify the abort condition behavior. This will help us understand how the skip logic is implemented and if it's correctly structured.


After analyzing the workflow file, I can now provide a definitive response about the abort condition behavior.

The abort condition logic looks solid and well-implemented! 🎯

The condition correctly handles two scenarios:

  • Skips when no source code changes (needs.cdk_changes.outputs['src'] == 'false')
  • Skips when the specific extra module hasn't changed (matrix.cdk_extra != 'n/a' && needs.cdk_changes.outputs[matrix.cdk_extra] == 'false')

The job name even includes a helpful skip indicator: "Check: '${{matrix.connector}}' (skip=${{needs.cdk_changes.outputs[matrix.cdk_extra] == 'false'}})" which makes it easy to see why a job was skipped.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify the abort condition behavior by checking the workflow runs

# Check recent workflow runs to see if jobs are being skipped as expected
gh run list --workflow=connector-tests.yml --limit 5 --json conclusion,displayTitle,url | \
  jq '.[] | select(.displayTitle | contains("skip=true")) | {conclusion: .conclusion, title: .displayTitle, url: .url}'

Length of output: 209


Script:

#!/bin/bash
# Let's analyze the workflow file to understand the abort condition logic better

# First, let's see the complete workflow file
cat .github/workflows/connector-tests.yml

# Then, let's check for any related workflow files that might provide more context
fd -e yml -e yaml . .github/workflows/ --exec cat {}

Length of output: 50402

🧰 Tools
🪛 actionlint (1.7.4)

98-98: shellcheck reported issue in this script: SC2086:info:2:67: Double quote to prevent globbing and word splitting

(shellcheck)


98-98: shellcheck reported issue in this script: SC2086:info:3:28: Double quote to prevent globbing and word splitting

(shellcheck)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant