Skip to content

feat(event): add tags filter to Push struct for event handling #157

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 5 commits into from
May 6, 2025

Conversation

amitksingh1490
Copy link
Contributor

@amitksingh1490 amitksingh1490 commented May 6, 2025

Summary by CodeRabbit

  • New Features

    • Added support for filtering push events by tags.
    • Extended workflow triggers to include pushes with tags matching "v*".
  • Style

    • Updated string formatting throughout the app to use a more modern and concise syntax for improved readability.

Copy link

coderabbitai bot commented May 6, 2025

Walkthrough

This update modernizes string formatting syntax throughout several files by adopting Rust 1.58+ inline named arguments in format strings and write! macros. Additionally, the Push struct in the workflow event module gains a new tags field and an associated add_tag method, enabling tag-based filtering for push events. The standard workflow's push event trigger is extended to include tags matching "v*". GitHub Actions workflows for autofix and CI are also updated to trigger on pushes to tags matching "v*".

Changes

File(s) Change Summary
crates/gh-workflow/src/cargo.rs Updated string formatting for toolchain variable to use Rust 1.58+ inline format string syntax.
crates/gh-workflow/src/ctx.rs Refactored all fmt::Display implementations to use named arguments in format strings for conciseness.
crates/gh-workflow/src/event.rs Added tags: Vec<String> field and add_tag method to Push struct for tag-based filtering.
crates/gh-workflow/src/generate.rs Replaced ErrorKind::Other with std::io::Error::other and updated job ID formatting to inline style.
crates/gh-workflow/src/rust_flag.rs Updated Display impl for RustFlags to use named argument formatting in all lint and combine variants.
crates/gh-workflow/src/toolchain.rs Modernized all string formatting and write! macro calls to use inline named arguments across enums.
crates/gh-workflow-tailcall/src/standard.rs Extended push event trigger in workflow_event to include tags matching pattern "v*" alongside "main" branch.
.github/workflows/autofix.yml Added push event trigger for tags matching pattern v* alongside main branch.
.github/workflows/ci.yml Added push event trigger for tags matching pattern v* alongside main branch.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Push
    participant Workflow

    User->>Push: call add_tag("v1.0")
    Push->>Push: tags.push("v1.0")
    Push-->>User: return updated Push

    User->>Workflow: use Push with tags filter
    Workflow->>Workflow: filter events by tags
Loading

Poem

In the warren, code gets neat and spry,
With curly braces waving, “Goodbye, old style!”
Tags now hop with Push, a brand new friend,
And formatting’s fresh from end to end.
Rusty carrots gleam, as rabbits cheer—
Modern syntax brings us springtime here! 🥕


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between eedfb53 and 44a0cd4.

📒 Files selected for processing (2)
  • .github/workflows/autofix.yml (1 hunks)
  • .github/workflows/ci.yml (1 hunks)
🔇 Additional comments (2)
.github/workflows/autofix.yml (1)

32-33: Enable tag-based triggers for autofix workflow
Including pushes to tags matching v* ensures the autofix workflow runs on version tags as intended, keeping it consistent with the CI workflow.

.github/workflows/ci.yml (1)

32-33: Enable tag-based triggers for CI workflow
Adding tags: - v* ensures CI runs on version-tagged pushes, aligning with the autofix workflow's trigger behavior.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

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

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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.

@amitksingh1490 amitksingh1490 requested a review from tusharmath May 6, 2025 12:15
@tusharmath tusharmath merged commit 26ef5f9 into main May 6, 2025
6 checks passed
@github-actions github-actions bot mentioned this pull request May 6, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants