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

Add whiteboard flag to webcompat sightline bugs #2498

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

jgraham
Copy link
Member

@jgraham jgraham commented Oct 11, 2024

Checklist

  • Type annotations added to new functions
  • Docs added to functions touched in main classes
  • Dry-run produced the expected results
  • The to-be-announced tag added if this is worth announcing

@suhaibmujahid suhaibmujahid self-assigned this Oct 15, 2024
@jgraham jgraham marked this pull request as ready for review November 4, 2024 17:44
@jgraham jgraham changed the title Webcompat sightline Add whiteboard flag to webcompat sightline bugs Nov 4, 2024
bugbot/gcp.py Outdated Show resolved Hide resolved
bugbot/gcp.py Outdated Show resolved Hide resolved
bugbot/gcp.py Outdated Show resolved Hide resolved
bugbot/rules/webcompat_sightline.py Outdated Show resolved Hide resolved
bugbot/rules/webcompat_sightline.py Outdated Show resolved Hide resolved
This should be set on all bugs that are part of the webcompat metrics
set, and by no bugs that aren't.

This initial approach just gets all the bugs that are either in that
set or have the whiteboard entry, and implements the logic to update
them in the client. Given that we expect initially to have ~700 bugs
in that set, this means we need to set the maximum number of bugs to
update to something rather high.
Copy link
Member

@suhaibmujahid suhaibmujahid left a comment

Choose a reason for hiding this comment

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

Thank you! LGTM! I have only minor comments.

We need to add this new rule to the bot's wiki page before deploying the new rule.

Comment on lines +39 to +43
elif self.WHITEBOARD_ENTRY in whiteboard:
self.autofix_changes[bug_id] = {
"whiteboard": whiteboard.replace(self.WHITEBOARD_ENTRY, "")
}
return bug
Copy link
Member

Choose a reason for hiding this comment

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

nit: this could improve the readability a bit.

Suggested change
elif self.WHITEBOARD_ENTRY in whiteboard:
self.autofix_changes[bug_id] = {
"whiteboard": whiteboard.replace(self.WHITEBOARD_ENTRY, "")
}
return bug
else:
if self.WHITEBOARD_ENTRY in whiteboard:
self.autofix_changes[bug_id] = {
"whiteboard": whiteboard.replace(self.WHITEBOARD_ENTRY, "")
}
return bug

self.sightline_ids = set()

def description(self) -> str:
return "Web Compat site report in the sightline metric set"
Copy link
Member

Choose a reason for hiding this comment

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

The description will be used as the title of the email.

Suggested change
return "Web Compat site report in the sightline metric set"
return "Bugs with the [webcompat:sightline] whiteboard tag updated"

@@ -75,4 +75,7 @@ python -m bugbot.rules.duplicate_copy_metadata --production
# Add `webcompat:platform-bug` keyword to bugs without a platform keyword
python -m bugbot.rules.webcompat_platform_without_keyword --production

# Add `[webcompat:sightline]` whiteboard entry to bugs in sightline metric set
Copy link
Member

Choose a reason for hiding this comment

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

We also remove it when it is applicable.

Suggested change
# Add `[webcompat:sightline]` whiteboard entry to bugs in sightline metric set
# Update `[webcompat:sightline]` whiteboard entry to bugs in sightline metric set

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.

3 participants