Skip to content

ci: reorder job steps #102

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

Merged
merged 1 commit into from
Dec 2, 2024
Merged

Conversation

aaronsteers
Copy link
Contributor

@aaronsteers aaronsteers commented Dec 2, 2024

Summary by CodeRabbit

  • Bug Fixes

    • Improved the evaluation of test outputs to provide clearer summaries and error logging for failed tests.
  • Chores

    • Updated workflow structure for better clarity and functionality in processing job outputs.

@github-actions github-actions bot added the ci label Dec 2, 2024
@aaronsteers aaronsteers enabled auto-merge (squash) December 2, 2024 22:14
Copy link
Contributor

coderabbitai bot commented Dec 2, 2024

📝 Walkthrough

Walkthrough

The pull request modifies the .github/workflows/connector-tests.yml file, specifically updating the connectors_ci job. A new step named "Evaluate Test Output" has been added to process a JSON output file for summarizing job results, replacing the previous upload step. The upload step has been repositioned to follow the evaluation step, maintaining its function to upload artifacts. The concurrency group name has been clarified in comments, while the overall workflow structure remains unchanged.

Changes

File Change Summary
.github/workflows/connector-tests.yml - Added "Evaluate Test Output" step to process JSON output and summarize job results.
- Moved upload step below evaluation step, retaining its functionality.
- Clarified concurrency group name in comments.

Possibly related PRs

Suggested labels

ci

Suggested reviewers

  • ChristoGrab

Wdyt about these suggestions?


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 (2)
.github/workflows/connector-tests.yml (2)

Line range hint 140-160: Consider enhancing error handling and output formatting? 🤔

A few suggestions to make this more robust and user-friendly, wdyt?

  1. The artifact URL is referenced before the upload step runs:
-          echo -e "\n[Download Job Output](${{steps.upload_job_output.outputs.artifact-url}})" >> $GITHUB_STEP_SUMMARY
+          # Move this line to the upload step
  1. We could add error handling for the file operations:
-          json_output_file=$(find airbyte/airbyte-ci/connectors/pipelines/pipeline_reports -name 'output.json' -print -quit)
+          json_output_file=$(find airbyte/airbyte-ci/connectors/pipelines/pipeline_reports -name 'output.json' -print -quit)
+          if [ -z "$json_output_file" ]; then
+            echo "::error::No output.json file found"
+            exit 1
+          fi
  1. The duration might be more readable with proper formatting:
-          echo "- Test Duration: $(printf "%.0f" ${run_duration})s" >> $GITHUB_STEP_SUMMARY
+          duration_mins=$(printf "%.1f" $(echo "${run_duration}/60" | bc -l))
+          echo "- Test Duration: ${duration_mins} minutes" >> $GITHUB_STEP_SUMMARY
🧰 Tools
🪛 actionlint (1.7.4)

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

(shellcheck)


142-142: shellcheck reported issue in this script: SC2086:info:4:16: Double quote to prevent globbing and word splitting

(shellcheck)


142-142: shellcheck reported issue in this script: SC2086:info:5:20: Double quote to prevent globbing and word splitting

(shellcheck)


142-142: shellcheck reported issue in this script: SC2086:info:6:21: Double quote to prevent globbing and word splitting

(shellcheck)


142-142: shellcheck reported issue in this script: SC2129:style:7:1: Consider using { cmd1; cmd2; } >> file instead of individual redirects

(shellcheck)


142-142: shellcheck reported issue in this script: SC2086:info:7:51: Double quote to prevent globbing and word splitting

(shellcheck)


142-142: shellcheck reported issue in this script: SC2086:info:8:33: Double quote to prevent globbing and word splitting

(shellcheck)


142-142: shellcheck reported issue in this script: SC2086:info:9:40: Double quote to prevent globbing and word splitting

(shellcheck)


142-142: shellcheck reported issue in this script: SC2086:info:9:62: Double quote to prevent globbing and word splitting

(shellcheck)


142-142: shellcheck reported issue in this script: SC2086:info:11:43: Double quote to prevent globbing and word splitting

(shellcheck)


142-142: shellcheck reported issue in this script: SC2086:info:13:89: Double quote to prevent globbing and word splitting

(shellcheck)


142-142: property "upload_job_output" is not defined in object type {no_changes: {conclusion: string; outcome: string; outputs: {string => string}}}

(expression)


161-168: How about enhancing the artifact handling? 💭

A couple of suggestions to improve the upload step:

  1. We could move the artifact URL link here and ensure it's always available:
 - name: Upload Job Output
   id: upload_job_output
   if: always() && steps.no_changes.outputs.status != 'cancelled'
   uses: actions/upload-artifact@v4
   with:
     name: ${{matrix.connector}}-job-output
     path: airbyte/airbyte-ci/connectors/pipelines/pipeline_reports
+     compression-level: 9  # Maximum compression to save storage
+ - name: Update Summary
+   if: always() && steps.no_changes.outputs.status != 'cancelled'
+   run: |
+     echo -e "\n[Download Job Output](${{steps.upload_job_output.outputs.artifact-url}})" >> $GITHUB_STEP_SUMMARY
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between a5a5860 and 3d5f8c5.

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

Line range hint 140-168: Overall changes look great! 👍

The reordering of steps and addition of the evaluation step improves the workflow's output handling and readability. The changes maintain proper error handling and artifact management while adding useful test result summaries.

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