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

🐛 Fix pr-checklist by using different github context variable #18

Merged
merged 1 commit into from
Feb 26, 2025

Conversation

devtobi
Copy link
Member

@devtobi devtobi commented Feb 26, 2025

Description

  • Changed checking of bot creation via github.event.pull_request.user.login variable
  • Removed deprecated action input

Summary by CodeRabbit

  • Chores
    • Refined the conditions for automating pull request checklist requirements to ensure that only eligible submissions trigger the process, improving workflow consistency.

Copy link
Contributor

coderabbitai bot commented Feb 26, 2025

Caution

Review failed

The pull request is closed.

Walkthrough

The change updates the conditional logic in the GitHub Actions workflow for executing the "Configure checklist requirement" step. The updated condition now checks that the pull request’s user login is not set to "dependabot[bot]" or "renovate[bot]" while still ensuring the pull request is not a draft. Additionally, the regex flag skipDescriptionRegexFlags: i was removed from the configuration.

Changes

File Change Summary
action-templates/.../action-pr-checklist/action.yml Adjusted the condition for executing the "Configure checklist requirement" step by switching from an actor check to a pull request user login check, and removed the regex flag.

Sequence Diagram(s)

sequenceDiagram
    participant PR as Pull Request
    participant GH as GitHub Actions Runner
    PR->>GH: Trigger workflow event
    GH->>GH: Check if PR is draft
    GH->>GH: Verify if user's login is not "dependabot[bot]" or "renovate[bot]"
    alt Valid condition
      GH->>GH: Execute "Configure checklist requirement" step
    else Invalid condition
      GH->>GH: Skip step execution
    end
Loading

Possibly related PRs

Suggested reviewers

  • hupling

Poem

I’m a little rabbit with a code-filled cheer,
Tweaking conditions so the path’s now clear.
No regex flags hopping about in the night,
Just a clean login check making it right.
With whiskers twitching and paws so light,
I celebrate smooth workflows with pure delight!


📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 14080db and 98fe1c3.

📒 Files selected for processing (1)
  • action-templates/actions/action-pr-checklist/action.yml (1 hunks)

🪧 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 generate docstrings to generate docstrings for 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.

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.

@devtobi
Copy link
Member Author

devtobi commented Feb 26, 2025

@devtobi devtobi marked this pull request as ready for review February 26, 2025 15:30
Copy link
Contributor

@hupling hupling left a comment

Choose a reason for hiding this comment

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

lgtm

@hupling hupling merged commit 0adbb60 into main Feb 26, 2025
20 checks passed
@hupling hupling deleted the fix/pr-checklist branch February 26, 2025 15:31
Copy link

🎉 This PR is included in version 1.0.2 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

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.

2 participants