-
Notifications
You must be signed in to change notification settings - Fork 124
Add script to fetch PR review comments #1722
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
Merged
Merged
Changes from 4 commits
Commits
Show all changes
18 commits
Select commit
Hold shift + click to select a range
da2efa9
feat: Add script to fetch PR review comments
google-labs-jules[bot] 0678049
feat: Enhance PR comment script with context and filters
google-labs-jules[bot] e84b02d
fix: Correct IndentationError in get_pr_review_comments.py
google-labs-jules[bot] 5948b96
fix: Correct --context-lines behavior for non-line-specific comments
google-labs-jules[bot] 565eed2
feat: Simplify diff hunk display and add comment filters
google-labs-jules[bot] 24a03ea
refactor: Update script description and format diff hunks
google-labs-jules[bot] 7e182aa
fix: Adjust 'next command' timestamp increment to 2 seconds
google-labs-jules[bot] 599845b
docs: Minor textual cleanups in PR comments script
google-labs-jules[bot] 77d1ed2
feat: Format output as Markdown for improved readability
google-labs-jules[bot] 9cb8d42
style: Adjust Markdown headings for structure and conciseness
google-labs-jules[bot] 203e88f
style: Adjust default context lines and Markdown spacing
google-labs-jules[bot] b900c7f
feat: Refactor comment filtering with new status terms and flags
google-labs-jules[bot] 5a4010f
feat: Improve context display and suggested command robustness
google-labs-jules[bot] 94417e7
style: Refactor hunk printing to use join for conciseness
google-labs-jules[bot] 9312a0c
fix: Align 'since' filter and next command with observed API behavior…
google-labs-jules[bot] 07d06bb
style: Condense printing of trailing hunk lines
google-labs-jules[bot] 7c7a269
chore: Remove specific stale developer comments
google-labs-jules[bot] 91bfae6
fix: Ensure removal of specific stale developer comments
google-labs-jules[bot] File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,182 @@ | ||
#!/usr/bin/env python3 | ||
# Copyright 2025 Google LLC | ||
# | ||
# Licensed under the Apache License, Version 2.0 (the "License"); | ||
# you may not use this file except in compliance with the License. | ||
# You may obtain a copy of the License at | ||
# | ||
# http://www.apache.org/licenses/LICENSE-2.0 | ||
# | ||
# Unless required by applicable law or agreed to in writing, software | ||
# distributed under the License is distributed on an "AS IS" BASIS, | ||
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
# See the License for the specific language governing permissions and | ||
# limitations under the License. | ||
|
||
"""Fetches and formats review comments from a GitHub Pull Request.""" | ||
|
||
import argparse | ||
import os | ||
import sys | ||
import firebase_github # Assumes firebase_github.py is in the same directory or python path | ||
jonsimantov marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
# Attempt to configure logging for firebase_github if absl is available | ||
try: | ||
from absl import logging as absl_logging | ||
# Set verbosity for absl logging if you want to see logs from firebase_github | ||
# absl_logging.set_verbosity(absl_logging.INFO) | ||
except ImportError: | ||
pass # firebase_github.py uses absl.logging.info, so this won't redirect. | ||
|
||
|
||
def print_contextual_diff_hunk(diff_hunk, comment_position, context_lines_count): | ||
if not diff_hunk or not diff_hunk.strip(): | ||
print("(No diff hunk available or content is empty)") | ||
return | ||
|
||
hunk_lines = diff_hunk.split('\n') # Note: Python's split('\n') is generally fine. | ||
jonsimantov marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
# Case 1: User explicitly wants the full hunk | ||
if context_lines_count == 0: | ||
print(diff_hunk) | ||
return | ||
|
||
# Case 2: Contextual display is requested (context_lines_count > 0), | ||
# but comment is not on a specific line or position is invalid for contextual display. | ||
if comment_position is None or comment_position < 1 or comment_position > len(hunk_lines): | ||
print("(Comment is not on a specific line in the diff, or position is invalid; full hunk context suppressed by --context-lines setting)") | ||
jonsimantov marked this conversation as resolved.
Show resolved
Hide resolved
|
||
# As an alternative to the above message, if the hunk is small, one might choose to print it. | ||
# However, sticking to the user's feedback of not wanting full hunks when context is specified: | ||
# print(diff_hunk) # This would be the old behavior for this case. | ||
return | ||
|
||
# Case 3: Contextual display is possible and requested | ||
comment_line_index = comment_position - 1 # Convert to 0-indexed | ||
|
||
start_index = max(0, comment_line_index - context_lines_count) | ||
end_index = min(len(hunk_lines), comment_line_index + context_lines_count + 1) | ||
|
||
# The following line was identified as redundant and is removed: | ||
# start_index = min(start_index, comment_line_index if comment_line_index >=0 else 0) | ||
|
||
for i in range(start_index, end_index): | ||
# Robust check, though start/end logic should prevent out-of-bounds | ||
if i >= 0 and i < len(hunk_lines): | ||
prefix = "> " if i == comment_line_index else " " | ||
jonsimantov marked this conversation as resolved.
Show resolved
Hide resolved
|
||
print(f"{prefix}{hunk_lines[i]}") | ||
|
||
|
||
def main(): | ||
default_owner = firebase_github.OWNER | ||
default_repo = firebase_github.REPO | ||
|
||
parser = argparse.ArgumentParser( | ||
description="Fetch review comments from a GitHub PR and format for use with Jules.", | ||
jonsimantov marked this conversation as resolved.
Show resolved
Hide resolved
|
||
formatter_class=argparse.RawTextHelpFormatter | ||
) | ||
parser.add_argument( | ||
"--pull_number", | ||
jonsimantov marked this conversation as resolved.
Show resolved
Hide resolved
|
||
type=int, | ||
required=True, | ||
help="Pull request number." | ||
) | ||
parser.add_argument( | ||
"--owner", | ||
type=str, | ||
default=default_owner, | ||
help=f"Repository owner. Defaults to '{default_owner}'." | ||
) | ||
parser.add_argument( | ||
"--repo", | ||
type=str, | ||
default=default_repo, | ||
help=f"Repository name. Defaults to '{default_repo}'." | ||
) | ||
parser.add_argument( | ||
"--token", | ||
type=str, | ||
default=os.environ.get("GITHUB_TOKEN"), | ||
help="GitHub token. Can also be set via GITHUB_TOKEN env var." | ||
) | ||
parser.add_argument( | ||
"--context-lines", | ||
type=int, | ||
default=10, | ||
jonsimantov marked this conversation as resolved.
Show resolved
Hide resolved
|
||
help="Number of context lines around the commented line from the diff hunk. Use 0 for the full hunk. Default: 10." | ||
) | ||
parser.add_argument( | ||
"--since", | ||
type=str, | ||
default=None, | ||
help="Only show comments created at or after this ISO 8601 timestamp (e.g., YYYY-MM-DDTHH:MM:SSZ)." | ||
) | ||
|
||
args = parser.parse_args() | ||
|
||
if not args.token: | ||
sys.stderr.write("Error: GitHub token not provided. Set GITHUB_TOKEN or use --token.\n") | ||
sys.exit(1) | ||
|
||
if args.owner != firebase_github.OWNER or args.repo != firebase_github.REPO: | ||
repo_url = f"https://github.com/{args.owner}/{args.repo}" | ||
if not firebase_github.set_repo_url(repo_url): | ||
sys.stderr.write(f"Error: Invalid repo URL: {args.owner}/{args.repo}. Expected https://github.com/owner/repo\n") | ||
sys.exit(1) | ||
print(f"Targeting repository: {firebase_github.OWNER}/{firebase_github.REPO}", file=sys.stderr) | ||
|
||
print(f"Fetching comments for PR #{args.pull_number} from {firebase_github.OWNER}/{firebase_github.REPO}...", file=sys.stderr) | ||
if args.since: | ||
print(f"Filtering comments created since: {args.since}", file=sys.stderr) | ||
|
||
comments = firebase_github.get_pull_request_review_comments( | ||
args.token, | ||
args.pull_number, | ||
since=args.since # Pass the 'since' argument | ||
) | ||
|
||
if not comments: | ||
print(f"No review comments found for PR #{args.pull_number} (or matching filters), or an error occurred.", file=sys.stderr) | ||
return | ||
|
||
print("\n--- Review Comments ---") | ||
for comment in comments: | ||
user = comment.get("user", {}).get("login", "Unknown user") | ||
path = comment.get("path", "N/A") | ||
file_line = comment.get("line", "N/A") | ||
hunk_position = comment.get("position") # This is the 1-indexed position in the hunk | ||
jonsimantov marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
body = comment.get("body", "").strip() | ||
diff_hunk = comment.get("diff_hunk") # Can be None or empty | ||
html_url = comment.get("html_url", "N/A") | ||
jonsimantov marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
comment_id = comment.get("id") | ||
in_reply_to_id = comment.get("in_reply_to_id") | ||
created_at = comment.get("created_at") | ||
|
||
if not body: | ||
continue | ||
|
||
print(f"Comment by: {user} (ID: {comment_id}){f' (In Reply To: {in_reply_to_id})' if in_reply_to_id else ''}") | ||
if created_at: | ||
print(f"Timestamp: {created_at}") | ||
|
||
if diff_hunk: # Only show status if it's a diff-related comment | ||
status_text = "[OUTDATED]" if hunk_position is None else "[CURRENT]" | ||
jonsimantov marked this conversation as resolved.
Show resolved
Hide resolved
|
||
print(f"Status: {status_text}") | ||
|
||
print(f"File: {path}") | ||
print(f"Line in File Diff: {file_line}") | ||
print(f"URL: {html_url}") | ||
|
||
print("--- Diff Hunk Context ---") | ||
if diff_hunk: | ||
print_contextual_diff_hunk(diff_hunk, hunk_position, args.context_lines) | ||
jonsimantov marked this conversation as resolved.
Show resolved
Hide resolved
|
||
else: | ||
print("(Comment not associated with a specific diff hunk)") | ||
|
||
print("--- Comment ---") | ||
print(body) | ||
print("----------------------------------------\n") | ||
|
||
if __name__ == "__main__": | ||
main() |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.