include pr title in posted comment

Author: dconeybe

.github/actions/dataconnect-send-notifications/action.yml

@@ -30,7 +30,6 @@ runs:
           python
           calculate_github_issue_for_commenting.py
           --issue-output-file=github_issue_number.txt
-          --pr-output-file=github_pr_number.txt
           --github-repository='${{ github.repository }}'
           --github-ref='${{ github.ref }}'
           --github-event-name='${{ github.event_name }}'
@@ -43,8 +42,6 @@ runs:
         set -xv
         issue="$(cat github_issue_number.txt)"
         echo "issue=$issue" >> "$GITHUB_OUTPUT"
-        pr="$(cat github_pr_number.txt)"
-        echo "pr=$pr" >> "$GITHUB_OUTPUT"
 
     - name: Post Comment on GitHub Issue
       if: steps.issue-id.outputs.issue != ''
@@ -57,12 +54,12 @@ runs:
           --github-issue='${{ steps.issue-id.outputs.issue }}'
           --github-workflow='${{ github.workflow }}'
           --github-repository='${{ github.repository }}'
+          --github-ref='${{ github.ref }}'
           --github-sha='${{ github.sha }}'
           --github-repository-html-url='${{ github.event.repository.html_url }}'
           --github-run-id='${{ github.run_id }}'
           --github-run-number='${{ github.run_number }}'
           --github-run-attempt='${{ github.run_attempt }}'
-          --triggering-pr='${{ steps.issue-id.outputs.pr }}'
         )
 
         while read -r line; do

firebase-dataconnect/ci/calculate_github_issue_for_commenting.py

@@ -15,117 +15,73 @@
 from __future__ import annotations
 
 import argparse
-import dataclasses
 import logging
 import pathlib
 import re
-import subprocess
 import typing
 
-if typing.TYPE_CHECKING:
-  from collections.abc import Iterable
+from util import fetch_pr_info, pr_number_from_github_ref
 
 
 def main() -> None:
   args = parse_args()
   logging.basicConfig(format="%(message)s", level=logging.INFO)
 
-  calculated_result = calculate_github_issue(
+  github_issue = calculate_github_issue(
     github_event_name=args.github_event_name,
     github_issue_for_scheduled_run=args.github_issue_for_scheduled_run,
     github_ref=args.github_ref,
     github_repository=args.github_repository,
     pr_body_github_issue_key=args.pr_body_github_issue_key,
   )
 
-  github_issue = calculated_result.issue
-  github_pr = calculated_result.pr
-
   issue_file_text = "" if github_issue is None else str(github_issue)
   logging.info("Writing '%s' to %s", issue_file_text, args.issue_output_file)
   args.issue_output_file.write_text(issue_file_text, encoding="utf8", errors="replace")
 
-  pr_file_text = "" if github_pr is None else str(github_pr)
-  logging.info("Writing '%s' to %s", pr_file_text, args.pr_output_file)
-  args.pr_output_file.write_text(pr_file_text, encoding="utf8", errors="replace")
-
-
-@dataclasses.dataclass(frozen=True)
-class CalculatedGitHubIssue:
-  issue: int | None
-  pr: int | None
-
 
 def calculate_github_issue(
   github_event_name: str,
   github_issue_for_scheduled_run: int,
   github_ref: str,
   github_repository: str,
   pr_body_github_issue_key: str,
-) -> CalculatedGitHubIssue:
+) -> int | None:
   if github_event_name == "schedule":
     logging.info(
       "GitHub Event name is: %s; using GitHub Issue: %s",
       github_event_name,
       github_issue_for_scheduled_run,
     )
-    return CalculatedGitHubIssue(
-      issue=github_issue_for_scheduled_run,
-      pr=None,  # scheduled runs are, by definition, not associated with a PR.
-    )
+    return github_issue_for_scheduled_run
 
   logging.info("Extracting PR number from string: %s", github_ref)
   pr_number = pr_number_from_github_ref(github_ref)
   if pr_number is None:
     logging.info("No PR number extracted")
-    return CalculatedGitHubIssue(None, None)
+    return None
   typing.assert_type(pr_number, int)
 
   logging.info("PR number extracted: %s", pr_number)
   logging.info("Loading body text of PR: %s", pr_number)
-  pr_body_text = load_pr_body(
+  pr_info = fetch_pr_info(
     pr_number=pr_number,
     github_repository=github_repository,
   )
 
   logging.info("Looking for GitHub Issue key in PR body text: %s=NNNN", pr_body_github_issue_key)
   github_issue = github_issue_from_pr_body(
-    pr_body=pr_body_text,
+    pr_body=pr_info.body,
     issue_key=pr_body_github_issue_key,
   )
 
   if github_issue is None:
     logging.info("No GitHub Issue key found in PR body")
-    return CalculatedGitHubIssue(issue=None, pr=pr_number)
+    return None
   typing.assert_type(github_issue, int)
 
   logging.info("Found GitHub Issue key in PR body: %s", github_issue)
-  return CalculatedGitHubIssue(issue=github_issue, pr=pr_number)
-
-
-def pr_number_from_github_ref(github_ref: str) -> int | None:
-  match = re.fullmatch("refs/pull/([0-9]+)/merge", github_ref)
-  return int(match.group(1)) if match else None
-
-
-def load_pr_body(pr_number: int, github_repository: str) -> str:
-  gh_args = log_pr_body_gh_args(pr_number=pr_number, github_repository=github_repository)
-  gh_args = tuple(gh_args)
-  logging.info("Running command: %s", subprocess.list2cmdline(gh_args))
-  return subprocess.check_output(gh_args, encoding="utf8", errors="replace")  # noqa: S603
-
-
-def log_pr_body_gh_args(pr_number: int, github_repository: str) -> Iterable[str]:
-  yield "gh"
-  yield "issue"
-  yield "view"
-  yield str(pr_number)
-  yield "--json"
-  yield "body"
-  yield "--jq"
-  yield ".body"
-  yield "-R"
-  yield github_repository
+  return github_issue
 
 
 def github_issue_from_pr_body(pr_body: str, issue_key: str) -> int | None:
@@ -139,7 +95,6 @@ def github_issue_from_pr_body(pr_body: str, issue_key: str) -> int | None:
 
 class ParsedArgs(typing.Protocol):
   issue_output_file: pathlib.Path
-  pr_output_file: pathlib.Path
   github_ref: str
   github_repository: str
   github_event_name: str
@@ -155,12 +110,6 @@ def parse_args() -> ParsedArgs:
     help="The file to which to write the calculated issue number"
     "if no issue number was found, then an empty file will be written",
   )
-  arg_parser.add_argument(
-    "--pr-output-file",
-    required=True,
-    help="The file to which to write the calculated triggering PR number"
-    "if no PR was found, then an empty file will be written",
-  )
   arg_parser.add_argument(
     "--github-ref",
     required=True,
@@ -192,7 +141,6 @@ def parse_args() -> ParsedArgs:
 
   parse_result = arg_parser.parse_args()
   parse_result.issue_output_file = pathlib.Path(parse_result.issue_output_file)
-  parse_result.pr_output_file = pathlib.Path(parse_result.pr_output_file)
   return typing.cast("ParsedArgs", parse_result)
 
 

firebase-dataconnect/ci/post_comment_for_job_results.py

@@ -22,6 +22,8 @@
 import tempfile
 import typing
 
+from util import fetch_pr_info, pr_number_from_github_ref
+
 if typing.TYPE_CHECKING:
   from collections.abc import Iterable, Sequence
 
@@ -49,17 +51,23 @@ def main() -> None:
 
 
 def generate_message_lines(data: ParsedArgs) -> Iterable[str]:
-  pr: int | None
-  if len(data.triggering_pr) == 0:
-    pr = None
+  logging.info("Extracting PR number from string: %s", data.github_ref)
+  pr_number = pr_number_from_github_ref(data.github_ref)
+  pr_title: str | None
+  if pr_number is None:
+    logging.info("No PR number extracted")
+    pr_title = None
   else:
-    try:
-      pr = int(data.triggering_pr)
-    except ValueError:
-      logging.warning("WARNING: unable to parse PR number as an int: %s", data.triggering_pr)
-      pr = None
+    pr_info = fetch_pr_info(
+      pr_number=pr_number,
+      github_repository=data.github_repository,
+    )
+    pr_title = pr_info.title
 
-  yield f"Posting from Pull Request {data.github_repository_html_url}/pull/{pr}"
+  if pr_number is not None:
+    yield (
+      f"Posting from Pull Request {data.github_repository_html_url}/pull/{pr_number} ({pr_title})"
+    )
 
   yield f"Result of workflow '{data.github_workflow}' at {data.github_sha}:"
 
@@ -125,13 +133,13 @@ class ParsedArgs(typing.Protocol):
   job_results: Sequence[JobResult]
   github_issue: int
   github_repository: str
+  github_ref: str
   github_workflow: str
   github_sha: str
   github_repository_html_url: str
   github_run_id: str
   github_run_number: str
   github_run_attempt: str
-  triggering_pr: str
 
 
 class ParseError(Exception):
@@ -154,14 +162,14 @@ def parse_args() -> ParsedArgs:
     help="The GitHub Issue number to which to post a comment",
   )
   arg_parser.add_argument(
-    "--triggering-pr",
+    "--github-repository",
     required=True,
-    help="The GitHub Pull Request number that triggered the workflow, or empty if not applicable.",
+    help="The value of ${{ github.repository }} in the workflow",
   )
   arg_parser.add_argument(
-    "--github-repository",
+    "--github-ref",
     required=True,
-    help="The value of ${{ github.repository }} in the workflow",
+    help="The value of ${{ github.ref }} in the workflow",
   )
   arg_parser.add_argument(
     "--github-workflow",

firebase-dataconnect/ci/util.py

@@ -0,0 +1,60 @@
+# 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.
+
+from __future__ import annotations
+
+import dataclasses
+import json
+import logging
+import re
+import subprocess
+import typing
+
+if typing.TYPE_CHECKING:
+  from collections.abc import Iterable
+
+
+@dataclasses.dataclass(frozen=True)
+class GitHubPrInfo:
+  title: str
+  body: str
+
+
+def fetch_pr_info(pr_number: int, github_repository: str) -> GitHubPrInfo:
+  gh_args = _fetch_pr_gh_args(pr_number=pr_number, github_repository=github_repository)
+  gh_args = tuple(gh_args)
+  logging.info("Running command: %s", subprocess.list2cmdline(gh_args))
+  output_str = subprocess.check_output(gh_args, encoding="utf8", errors="replace")  # noqa: S603
+  logging.info("%s", output_str)
+  output = json.loads(output_str)
+  return GitHubPrInfo(
+    title=output["title"],
+    body=output["body"],
+  )
+
+
+def _fetch_pr_gh_args(pr_number: int, github_repository: str) -> Iterable[str]:
+  yield "gh"
+  yield "issue"
+  yield "view"
+  yield str(pr_number)
+  yield "--json"
+  yield "title,body"
+  yield "-R"
+  yield github_repository
+
+
+def pr_number_from_github_ref(github_ref: str) -> int | None:
+  match = re.fullmatch("refs/pull/([0-9]+)/merge", github_ref)
+  return int(match.group(1)) if match else None