Skip to content

feat: add PullRequestLabelEventsStream #365

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

Draft
wants to merge 3 commits into
base: main
Choose a base branch
from
Draft

feat: add PullRequestLabelEventsStream #365

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d37c605
add PullRequestLabelEventsStream
malexmad Feb 21, 2025
38a4441
add pull number
malexmad Feb 21, 2025
fa88b51
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Feb 21, 2025
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
65 changes: 65 additions & 0 deletions tap_github/repository_streams.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1552,6 +1552,71 @@ class ReviewsStream(GitHubRestStream):
).to_dict()


class PullRequestLabelEventsStream(GitHubRestStream):
"""A stream dedicated to fetching label events (added/removed) for pull requests in a repository.
Note: This stream uses the issues timeline API since GitHub treats PRs as issues internally."""

name = "pull_request_label_events"
path = "/repos/{org}/{repo}/issues/{pull_number}/timeline"
primary_keys: ClassVar[list[str]] = ["node_id"]
parent_stream_type = PullRequestsStream
ignore_parent_replication_key = True
state_partitioning_keys: ClassVar[list[str]] = ["repo", "org", "pull_number"]
tolerated_http_errors: ClassVar[list[int]] = [404]

def parse_response(self, response: requests.Response) -> Iterable[dict]:
"""Parse the response and filter for label events only."""
for event in super().parse_response(response):
if event.get("event") == "labeled" or event.get("event") == "unlabeled":
yield event

schema = th.PropertiesList(
# Parent Keys
th.Property("repo", th.StringType),
th.Property("org", th.StringType),
th.Property("repo_id", th.IntegerType),
th.Property("pull_number", th.IntegerType),
# Event Keys
th.Property("id", th.IntegerType),
th.Property("node_id", th.StringType),
th.Property("url", th.StringType),
th.Property("event", th.StringType),
th.Property("commit_id", th.StringType),
th.Property("created_at", th.DateTimeType),
th.Property(
"actor",
th.ObjectType(
th.Property("login", th.StringType),
th.Property("id", th.IntegerType),
th.Property("node_id", th.StringType),
th.Property("avatar_url", th.StringType),
th.Property("gravatar_id", th.StringType),
th.Property("url", th.StringType),
th.Property("html_url", th.StringType),
th.Property("followers_url", th.StringType),
th.Property("following_url", th.StringType),
th.Property("gists_url", th.StringType),
th.Property("starred_url", th.StringType),
th.Property("subscriptions_url", th.StringType),
th.Property("organizations_url", th.StringType),
th.Property("repos_url", th.StringType),
th.Property("events_url", th.StringType),
th.Property("received_events_url", th.StringType),
th.Property("type", th.StringType),
th.Property("site_admin", th.BooleanType),
),
),
th.Property(
"label",
th.ObjectType(
th.Property("name", th.StringType),
th.Property("color", th.StringType),
),
),
th.Property("performed_via_github_app", th.StringType),
).to_dict()


class ReviewCommentsStream(GitHubRestStream):
name = "review_comments"
path = "/repos/{org}/{repo}/pulls/comments"
Expand Down
2 changes: 2 additions & 0 deletions tap_github/streams.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@
ProjectsStream,
PullRequestCommits,
PullRequestDiffsStream,
PullRequestLabelEventsStream,
PullRequestsStream,
ReadmeHtmlStream,
ReadmeStream,
Expand Down Expand Up @@ -100,6 +101,7 @@ def __init__(self, valid_queries: set[str], streams: list[type[Stream]]) -> None
PullRequestCommits,
PullRequestDiffsStream,
PullRequestsStream,
PullRequestLabelEventsStream,
ReadmeHtmlStream,
ReadmeStream,
ReleasesStream,
Expand Down