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

refactor(ci): finish matrix migration and update release workflow #2475

Merged
merged 6 commits into from
Jul 16, 2024

Conversation

gartnera
Copy link
Member

@gartnera gartnera commented Jul 12, 2024

Description

  • Migrate remaining e2e tests from advanced to e2e matrix
  • Make workflow_dispatch actually work
  • Use actions/action-script to improve label check logic (shell was doing substring matching not array includes)
  • Remove CI checks from release workflow and instead just run all CI on every push to release branches

Summary by CodeRabbit

  • Chores
    • Updated workflows to enhance flexibility and coverage of testing, including new test types and refined logic for test execution triggers.
    • Streamlined publish-release workflow, removing redundant checks and tests.
    • Adjusted branch-specific triggers for various workflows.
    • Updated Go version requirement to 1.22 in the documentation.

Copy link
Contributor

coderabbitai bot commented Jul 12, 2024

Walkthrough

Recent updates across several GitHub workflow files enhance the automation and testing processes. Changes include adding specific branches for triggering workflows, introducing new test types and conditional logic, removing redundant checks, and updating dependencies. These adjustments aim to streamline workflows, improve flexibility, and ensure comprehensive testing coverage.

Changes

File Change Summary
.github/workflows/build.yml Added release/* branch to trigger the workflow on push events and removed the ready_for_review event trigger.
.github/workflows/e2e.yml Introduced new workflow dispatch inputs, updated conditional logic for setting test flags, added new test types (upgrade-import-mainnet-test, performance-test, stateful-data-test), and adjusted job conditions and dependencies.
.github/workflows/publish-release.yml Streamlined workflow steps by removing redundant checks and tests (e.g., gosec, lint, build-test). Updated descriptions for skipping certain checks for clarity.
.github/workflows/reusable-e2e.yml Modified Slack notification logic to trigger on failure for any event type, removing the specific check for the develop branch.
.github/workflows/sast-linters.yml Added specific branches (develop and release/*) for push event triggers, removed the edited event type for pull requests.
readme.md Updated the required Go version from 1.20 to 1.22 in the prerequisites section.

Poem

In the realm of code so bright,
Workflows change to aid our plight.
Tests are smarter, branches true,
With streamlined checks, the skies are blue.
Go's version climbs, we cheer, "Hurray!"
CodeRabbit hops, leading the way! 🐇✨


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

@gartnera gartnera added the no-changelog Skip changelog CI check label Jul 12, 2024
@github-actions github-actions bot added the ci Changes to CI pipeline or github actions label Jul 12, 2024
@gartnera gartnera added the UPGRADE_LIGHT_TESTS Run make start-upgrade-test-light label Jul 15, 2024
Copy link

codecov bot commented Jul 15, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 47.21%. Comparing base (a076710) to head (f71abdc).
Report is 3 commits behind head on develop.

Additional details and impacted files

Impacted file tree graph

@@             Coverage Diff             @@
##           develop    #2475      +/-   ##
===========================================
+ Coverage    47.16%   47.21%   +0.05%     
===========================================
  Files          444      444              
  Lines        29346    29358      +12     
===========================================
+ Hits         13840    13861      +21     
+ Misses       14696    14691       -5     
+ Partials       810      806       -4     

see 11 files with indirect coverage changes

@gartnera gartnera marked this pull request as ready for review July 15, 2024 17:17
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 7363b33 and f71abdc.

Files selected for processing (6)
  • .github/workflows/build.yml (2 hunks)
  • .github/workflows/e2e.yml (4 hunks)
  • .github/workflows/publish-release.yml (3 hunks)
  • .github/workflows/reusable-e2e.yml (1 hunks)
  • .github/workflows/sast-linters.yml (1 hunks)
  • readme.md (1 hunks)
Files skipped from review due to trivial changes (3)
  • .github/workflows/build.yml
  • .github/workflows/sast-linters.yml
  • readme.md
Additional comments not posted (8)
.github/workflows/reusable-e2e.yml (1)

104-104: Ensure Slack notifications on failure for all event types.

The change ensures that Slack notifications are triggered on failure for any event type, which is a good practice to keep track of failures.

.github/workflows/publish-release.yml (1)

14-14: Clarify the description for skipping checks.

The updated description clarifies which checks are skipped, improving the readability and understanding of the workflow.

.github/workflows/e2e.yml (6)

7-7: Trigger the workflow on push to release branches.

The workflow is now triggered by push events to the release/* branch, which ensures that the end-to-end tests are run for release branches as well.


16-45: Add workflow_dispatch inputs for various test types.

The addition of workflow_dispatch inputs allows for more granular control over which tests to run when manually triggering the workflow. This enhances the flexibility of the testing process.


60-63: Update outputs in matrix-conditionals step.

The updated outputs in the matrix-conditionals step ensure that the correct test flags are set based on the event type, improving the accuracy of the test execution conditions.


65-114: Transition from CLI to GitHub API for context access and revise conditional logic.

The transition from CLI to GitHub API for context access helps avoid race conditions and provides more reliable data. The revised conditional logic for setting test flags based on event types ensures that the correct tests are run under different conditions.


131-142: Add new test job executions and adjust job conditions based on test flags.

The addition of new test job executions and the adjustment of job conditions based on test flags enhance the coverage and flexibility of the end-to-end testing process.


153-155: Update e2e-ok job dependencies.

The updated dependencies for the e2e-ok job ensure that it runs after the matrix-conditionals and e2e jobs, maintaining the correct workflow sequence.

Copy link
Contributor

@swift1337 swift1337 left a comment

Choose a reason for hiding this comment

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

LGTM, left some comments

.github/workflows/e2e.yml Show resolved Hide resolved
.github/workflows/e2e.yml Show resolved Hide resolved
@gartnera gartnera added this pull request to the merge queue Jul 16, 2024
Merged via the queue into develop with commit 0f95277 Jul 16, 2024
39 checks passed
@gartnera gartnera deleted the refactor-ci-v1 branch July 16, 2024 15:41
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.

4 participants