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: run runtime/v2 tests in CI #22769

Merged
merged 2 commits into from
Dec 5, 2024
Merged

ci: run runtime/v2 tests in CI #22769

merged 2 commits into from
Dec 5, 2024

Conversation

julienrbrt
Copy link
Member

@julienrbrt julienrbrt commented Dec 5, 2024

Description

I was confused why #22760 never got catched before.
That's the reason. I'll mark the job as required afterwards.


Author Checklist

All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.

I have...

  • included the correct type prefix in the PR title, you can find examples of the prefixes below:
  • confirmed ! in the type prefix if API or client breaking change
  • targeted the correct branch (see PR Targeting)
  • provided a link to the relevant issue or specification
  • reviewed "Files changed" and left comments if necessary
  • included the necessary unit and integration tests
  • added a changelog entry to CHANGELOG.md
  • updated the relevant documentation or specification, including comments for documenting Go code
  • confirmed all CI checks have passed

Reviewers Checklist

All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.

Please see Pull Request Reviewer section in the contributing guide for more information on how to review a pull request.

I have...

  • confirmed the correct type prefix in the PR title
  • confirmed all author checklist items have been addressed
  • reviewed state machine logic, API design and naming, documentation is accurate, tests and test coverage

Summary by CodeRabbit

  • New Features

    • Introduced a new testing job, runtime-v2, to enhance the testing capabilities of the workflow.
  • Improvements

    • Expanded testing coverage for the runtime/v2 directory, ensuring more robust validation of changes.

Copy link
Contributor

coderabbitai bot commented Dec 5, 2024

📝 Walkthrough

Walkthrough

The pull request introduces a new job called runtime-v2 to the GitHub Actions workflow located in .github/workflows/v2-test.yml. This job is designed to run on ubuntu-latest and incorporates a strategy that avoids failing fast. It includes steps for checking out the repository, setting up Go version 1.23 with caching, and using get-diff-action to detect changes in specific Go files and modules within the runtime/v2 directory. If changes are found, it runs tests with specific flags. Existing jobs remain unchanged but are now part of a broader testing context.

Changes

File Change Summary
.github/workflows/v2-test.yml Added a new job runtime-v2 that checks for changes in the runtime/v2 directory and runs tests.

Possibly related PRs

Suggested labels

Type: CI, backport/v0.52.x

Suggested reviewers

  • tac0turtle
  • sontrinh16
  • akhilkumarpilli

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

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 (1)
.github/workflows/v2-test.yml (1)

36-39: Add coverage reporting to match step name

The step is named "test & coverage report creation" but doesn't generate coverage reports. Consider adding the -coverprofile flag to match other test jobs and the step name.

-          cd runtime/v2 && go test -mod=readonly -race -timeout 30m -tags='ledger test_ledger_mock'
+          cd runtime/v2 && go test -mod=readonly -race -timeout 30m -tags='ledger test_ledger_mock' -coverprofile=coverage.txt -covermode=atomic
📜 Review details

Configuration used: .coderabbit.yml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between f8a3226 and c2b730b.

📒 Files selected for processing (1)
  • .github/workflows/v2-test.yml (1 hunks)
🔇 Additional comments (4)
.github/workflows/v2-test.yml (4)

17-21: LGTM: Job configuration follows best practices

The job configuration is consistent with other test jobs and correctly uses fail-fast: false to ensure all tests run even if one fails.


29-35: LGTM: Change detection patterns are well-defined

The patterns correctly capture all relevant files in the runtime/v2 module, including Go source files and dependency manifests.


22-28: Verify Go version specification

The workflow specifies Go version "1.23" which is not yet released (current stable is 1.22). While this matches other jobs, it might cause issues.

✅ Verification successful

Let me check the Go version in the repository's go.mod file to verify if this is intentional or a potential issue.


Go version 1.23 specification is correct

The Go version 1.23 specified in the workflow file matches the version declared in go.mod (1.23.2). This is consistent across all workflow files and aligns with the project's requirements.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Check if other workflows use the same Go version
rg -l "go-version: \"1\.23\"" .github/workflows/

Length of output: 633


Script:

#!/bin/bash
# Check Go version in go.mod
cat go.mod | grep -E "^go [0-9]+\.[0-9]+"

Length of output: 53


17-40: Verify required status check configuration

As mentioned in the PR objectives, this job should be marked as required. Please ensure the branch protection rules are updated to include this new job as a required status check.

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.

3 participants