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.

Sign up for GitHub

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

The PR checker should check DeveloperFixed Notes #295

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

The PR checker should check DeveloperFixed Notes #295

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
38ba753
The PR checker should check DeveloperFixed Notes
pthariensflame Nov 26, 2021
67a0479
PR Checker should check PR Link for DeveloperFixed
pthariensflame Nov 26, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion format_checker/pr_checker.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ def check_status_consistency(filename, row, i, log):
else:
check_pr_link(filename, row, i, log)

if row["Status"] in ["InspiredAFix", "Skipped", "MovedOrRenamed"]:
if row["Status"] in ["InspiredAFix", "Skipped", "MovedOrRenamed", "DeveloperFixed"]:
Copy link
Contributor

Choose a reason for hiding this comment

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

I assume that the desire to require Notes for DeveloperFixed status is to have people provide the information for when a flaky test was fixed.

Although, it is certainly nice if people would provide Notes detailing when the developer fixed a particular flaky test, I don't envision that being easy for most to provide. E.g., for someone that runs some flaky test detection tool on the latest version of the project and finds that a particular flaky test is no longer flaky, we do not want to limit the contribution of such information only if that person provides Notes to describe when the test is fixed by the developer.

Unless there are other reasons to add this requirement, I suggest removing this change from this PR.


# Should contain a note
if row["Notes"] == "":
Expand All @@ -118,6 +118,11 @@ def check_status_consistency(filename, row, i, log):
else:
check_pr_link(filename, row, i, log)

if row["Status"] == "DeveloperFixed":
Copy link
Contributor

Choose a reason for hiding this comment

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

This line and Line 123 can be combined

Copy link
Contributor

Choose a reason for hiding this comment

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

Better yet you can simply add row["Status"] == "DeveloperFixed" to Line 126 (Line 128 can then be triggered only for row["Status"] == "") and remove this whole if block

# Should contain either no PR Link or a valid one
if not row["PR Link"] == "":
check_pr_link(filename, row, i, log)

if row["Status"] == "" and row["PR Link"] != "":
check_pr_link(filename, row, i, log)
log_std_error(filename, log, i, row, "Status should not be empty when a PR link is provided.")
Expand Down