feat(ci): add advisory warnings for large PRs and generated artifacts#388
feat(ci): add advisory warnings for large PRs and generated artifacts#388CoderPrateek971 wants to merge 15 commits into
Conversation
utksh1
left a comment
There was a problem hiding this comment.
Requesting changes. The PR-size advisory workflow is useful, but the PR also rewrites large parts of CONTRIBUTING.md with unrelated formatting churn. Please keep this PR focused on the workflow and minimal contributor guidance only; avoid broad markdown restyling unless it is part of a separate docs cleanup PR.
|
Thanks for the review @utksh1 . I’ve updated the PR to keep it focused only on the PR-size advisory workflow and removed the unrelated The workflow has also been cleaned up for readability while keeping the functionality unchanged. |
|
Thanks for following up. Clarifying the change request so it is actionable: Why this is blocked: What to do next:
|
utksh1
left a comment
There was a problem hiding this comment.
Re-reviewed after the update, but this is still not mergeable. The new .github/workflows/pr-size-warning.yml file is wrapped in Markdown code fences, so it is not valid workflow YAML, and CONTRIBUTING.md is still heavily reformatted beyond the PR-size advisory scope. Please remove the fences and keep docs changes minimal/focused.
|
Fixed! Removed the Markdown code fences around the YAML file, and fully reverted |
utksh1
left a comment
There was a problem hiding this comment.
Re-reviewed latest state. The workflow YAML is no longer fenced, but CONTRIBUTING.md is still broadly reformatted and loses existing Markdown structure/code fences far beyond the PR-size advisory scope. Please restore CONTRIBUTING.md and limit this PR to the advisory workflow plus a small focused docs note if needed.
|
Thanks for the feedback! I've updated the PR to address the issues:
Let me know if this looks good to go! |
|
Re-reviewed after the latest push. Still blocked: CONTRIBUTING.md still needs to be restored/kept minimal so this PR remains focused on the PR-size advisory workflow and a small targeted docs note only. |
Description
Large PRs with generated artifacts are hard to review. This PR adds a lightweight GitHub Actions workflow that warns contributors when a PR contains unusually large diffs or accidentally includes generated testing folders.
Approach
.github/workflows/pr-advisory.ymlthat triggers on PR updates.github.eventcontext for total lines and files changed.ghCLI to check file paths specifically forplaywright-report/andtest-results/.::warningannotations and Step Summaries to make the warnings highly visible without digging through logs.exit 0), ensuring it does not fail CI builds, leaving the final decision to maintainers.CONTRIBUTING.mdto document the threshold (50 files / 1000 lines) and explain how contributors can fix the artifact warning.Linked Issues
Closes #120
Tests Run
pull-requests: read) are usedNotes
This change strictly improves the contributor and reviewer experience. It does not touch or affect the backend API or frontend React code.