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: Skip PR title checks on draft PRs #337

Merged
merged 9 commits into from
Aug 10, 2024

Conversation

aaronsteers
Copy link
Contributor

@aaronsteers aaronsteers commented Aug 10, 2024

Summary by CodeRabbit

  • Chores
    • Enhanced the GitHub Actions workflow to include a broader range of events for trigger initiation, improving responsiveness to pull request status changes.
    • Added a conditional check to prevent the semantic pull request action from running on draft pull requests, optimizing workflow efficiency.

Copy link

coderabbitai bot commented Aug 10, 2024

Walkthrough

Walkthrough

This update enhances the GitHub Actions workflow by modifying the event trigger to include more scenarios, such as ready_for_review, and by adding a condition that ensures the amannn/action-semantic-pull-request action only executes for non-draft pull requests. These changes improve the workflow's responsiveness and efficiency by allowing it to react to a broader range of pull request events while avoiding unnecessary checks during development.

Changes

Files Change Summary
.github/workflows/semantic_pr_check.yml Changed event trigger to pull_request, allowing broader event response, and added an if condition to restrict execution to non-draft pull requests.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant GitHubActions
    participant SemanticCheck

    User->>GitHubActions: Create/Update Pull Request
    GitHubActions->>SemanticCheck: Check if draft
    alt Not Draft
        SemanticCheck->>GitHubActions: Execute semantic checks
    else Draft
        GitHubActions->>User: Skip semantic checks
    end
Loading

What do you think of this updated representation? Would you like to include any additional details or adjustments?


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:

‼️ IMPORTANT
Auto-reply has been disabled for this repository in the CodeRabbit settings. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged.

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

@aaronsteers aaronsteers marked this pull request as ready for review August 10, 2024 01:59
@aaronsteers aaronsteers changed the title ci(draft): skip pr title checks on draft prs CI: skip pr title checks on draft prs Aug 10, 2024
@aaronsteers aaronsteers changed the title CI: skip pr title checks on draft prs CI: Skip pr title checks on draft prs Aug 10, 2024
@aaronsteers aaronsteers marked this pull request as draft August 10, 2024 02:53
@aaronsteers aaronsteers changed the title CI: Skip pr title checks on draft prs blerg: Skip pr title checks on draft prs Aug 10, 2024
@aaronsteers aaronsteers marked this pull request as ready for review August 10, 2024 02:55
@aaronsteers aaronsteers changed the title blerg: Skip pr title checks on draft prs CI: Skip pr title checks on draft prs Aug 10, 2024
@aaronsteers aaronsteers changed the title CI: Skip pr title checks on draft prs CI: Skip PR title checks on draft PRs Aug 10, 2024
@aaronsteers aaronsteers enabled auto-merge (squash) August 10, 2024 02:59
@aaronsteers aaronsteers merged commit 39fe9a3 into main Aug 10, 2024
25 of 29 checks passed
@aaronsteers aaronsteers deleted the aj/ci/skip-pr-title-check-on-draft-prs branch August 10, 2024 03:10
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.

1 participant