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

feat: Trigger on opened PR, ready for review or sourcery-review label #4

Merged
merged 4 commits into from
Nov 29, 2023

Conversation

brendanator
Copy link
Contributor

No description provided.

Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

Sourcery logo Sourcery Review:

PR Type: Enhancement

Summary of PR: This PR updates the GitHub Actions workflow to trigger the Sourcery code review when a pull request is opened in a non-draft state, when it transitions from draft to ready for review, or when the sourcery-review label is applied.

General PR suggestions

  • Ensure that the logical conditions in the workflow file are correctly ordered to prevent any unintended behavior. Specifically, use parentheses to clarify the order of evaluation in logical expressions.
  • Review the comments in the workflow file for clarity and consistency. Make sure that the comments accurately describe the conditions under which the workflow is triggered.
  • Consider any edge cases that might affect when the workflow should be triggered, such as the presence of specific labels that might indicate a pull request is not yet ready for review even if it is not in draft state.

@brendanator brendanator marked this pull request as draft November 29, 2023 22:08
@brendanator brendanator marked this pull request as ready for review November 29, 2023 22:08
Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

Sourcery logo Sourcery Review:

PR Type: Enhancement

Summary of PR: This PR updates the GitHub Actions workflow to trigger the Sourcery code review on additional events, specifically when a pull request is opened (provided it's not a draft), when a draft pull request is marked as ready for review, and when the sourcery-review label is applied.

General PR suggestions

  • Ensure that the comments in the workflow file are consistent and clear, especially where triggers for the actions are described. This helps maintain readability and understanding of the workflow's purpose.
  • Review the logical expressions used in the workflow's conditional statements to prevent any unintended behavior due to operator precedence. Using parentheses to group conditions can improve clarity and correctness.
  • Address any minor typos in the comments to maintain a professional and polished codebase.
  • Verify that the workflow behaves as expected with the new triggers, especially in edge cases where a pull request might change states rapidly. This could help catch any potential issues before they affect the repository's operation.

@brendanator brendanator added the sourcery-review Request a review from sourcery label Nov 29, 2023
Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

Sourcery logo Sourcery Review:

PR Type: Enhancement

Summary of PR: This PR updates the GitHub Actions workflow to trigger the Sourcery code review on additional events: when a pull request is opened (provided it's not a draft), when a draft pull request is marked as ready for review, and when the sourcery-review label is added to a pull request.

General PR suggestions

  • Ensure that the logical conditions in the workflow file are correctly ordered to prevent any unintended behavior. Specifically, use parentheses to group conditions properly when mixing 'AND' and 'OR' operators.
  • Add explanatory comments next to new trigger conditions for clarity and consistency with the existing documentation in the workflow file.
  • Review the workflow to ensure it only runs on relevant labeled events to avoid unnecessary runs, which could save on build minutes and reduce noise.
  • Correct any typos in the comments to maintain professionalism and clarity in the documentation.
  • Consider the overall readability and maintainability of the workflow file, ensuring that it is easy for future contributors to understand and modify the triggers as needed.

@brendanator brendanator added the enhancement New feature or request label Nov 29, 2023
@brendanator brendanator merged commit 23dc2b7 into main Nov 29, 2023
@brendanator brendanator deleted the brendan/feat/update-sourcery-review-triggers branch November 29, 2023 22:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request sourcery-review Request a review from sourcery
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant