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: use single input for e2e workflow_dispatch #2777

Merged
merged 1 commit into from
Aug 27, 2024

Conversation

gartnera
Copy link
Member

@gartnera gartnera commented Aug 27, 2024

With #2763 we now have 11 e2e test targets. This is greater than the maximum number of inputs (10). Reference

Move to a single comma separated input.

Example run: https://github.com/zeta-chain/node/actions/runs/10583082282

Summary by CodeRabbit

  • New Features
    • Simplified test configuration by introducing a single input parameter, make-targets, allowing users to specify multiple tests in a comma-separated format.
  • Improvements
    • Enhanced workflow flexibility and maintainability, reducing potential user errors in specifying test parameters.

Copy link
Contributor

coderabbitai bot commented Aug 27, 2024

Walkthrough

Walkthrough

The changes involve the restructuring of the input parameters in the GitHub Actions workflow configuration file .github/workflows/e2e.yml. The previous multiple boolean inputs for specific tests have been consolidated into a single parameter called make-targets, which accepts a comma-separated list of make targets. This modification simplifies the workflow configuration and streamlines the handling of test types.

Changes

File Change Summary
.github/workflows/e2e.yml Removed multiple boolean input parameters for tests; introduced a single input make-targets for specifying tests as a comma-separated list. Updated output settings to align with the new structure.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant GitHub Actions
    participant Workflow

    User->>GitHub Actions: Trigger Workflow with `make-targets`
    GitHub Actions->>Workflow: Receive `make-targets` input
    Workflow->>Workflow: Parse `make-targets`
    alt Test Included
        Workflow->>Workflow: Execute corresponding test
    else No Test Included
        Workflow->>Workflow: Skip execution
    end
Loading

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.

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.

@github-actions github-actions bot added the ci Changes to CI pipeline or github actions label Aug 27, 2024
@gartnera gartnera added the no-changelog Skip changelog CI check label Aug 27, 2024
@gartnera gartnera marked this pull request as ready for review August 27, 2024 17:37
@gartnera gartnera requested a review from a team as a code owner August 27, 2024 17:37
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 42eb4bd and 828b4be.

Files selected for processing (1)
  • .github/workflows/e2e.yml (2 hunks)
Additional comments not posted (2)
.github/workflows/e2e.yml (2)

16-19: LGTM!

The new input parameter make-targets is well-defined and addresses the limitation of having more than 10 inputs.

The code changes are approved.


91-101: LGTM!

The logic for parsing the make-targets input and setting the outputs is correctly implemented.

The code changes are approved.

@gartnera gartnera added this pull request to the merge queue Aug 27, 2024
Merged via the queue into develop with commit 580b360 Aug 27, 2024
57 checks passed
@gartnera gartnera deleted the ci-e2e-make-targets-csv branch August 27, 2024 21:18
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants