Skip to content

Add AI generated PRs to release notes. #977

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

Merged
balagan73 merged 7 commits into from
Feb 4, 2026
Merged

Add AI generated PRs to release notes. #977

Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
6ac3b73
Add AI generated PRs to release notes.
balagan73 Jan 29, 2026
68a9762
Fetch related issue number from the Development section.
balagan73 Jan 30, 2026
1035ff4
Fix release notes generator bug with PR#.
balagan73 Feb 3, 2026
19a1105
Fix issue title.
balagan73 Feb 3, 2026
8d536a0
Copilot review fixes.
balagan73 Feb 3, 2026
f0f280b
Fix phpcs.
balagan73 Feb 3, 2026
a11e7c8
Fix get linked issues from PR body.
balagan73 Feb 3, 2026
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
235 changes: 174 additions & 61 deletions robo-components/ReleaseNotesTrait.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,11 +64,12 @@ public function generateReleaseNotes(?string $tag = NULL): void {
// This is the heart of the release notes, the git history, we get all the
// commits since the specified last version and later on we parse
// the output. Optionally we enrich it with metadata from GitHub REST API.
$git_command = "git log --pretty=format:'%s¬¬|¬¬%b'";
$git_command = "git log --pretty=format:'%s'";
if (!empty($tag)) {
$git_command .= " $tag..";
}
$log = $this->taskExec($git_command)->printOutput(FALSE)->run()->getMessage();
// Each line contains the first line of the commit message.
$lines = explode("\n", $log);

$this->say('Copy release notes below');
Expand All @@ -84,7 +85,7 @@ public function generateReleaseNotes(?string $tag = NULL): void {
$changed_files = 0;

foreach ($lines as $line) {
$log_messages = explode("¬¬|¬¬", $line);
$issue_number = NULL;
$pr_matches = [];

// Here we need to handle two cases.
Expand All @@ -94,97 +95,76 @@ public function generateReleaseNotes(?string $tag = NULL): void {
// Explanation (#1234)
preg_match_all('/Merge pull request #([0-9]+)/', $line, $pr_matches);

if (count($log_messages) < 2) {
// No log message at all, not meaningful for changelog.
continue;
}
if (!isset($pr_matches[1][0])) {
// Could not detect PR number or it"s a Squash and Merge.
$pr_matches = [];
preg_match_all('!\(#([0-9]+)\)!', $line, $pr_matches);
if (!isset($pr_matches[0][0])) {
// If we have no pr number, continue.
if (!isset($pr_matches[1][0])) {
continue;
}
}
else {
// In case of simple merges, we get the issue number from the log,
// as the issue number is a required part of the branch name.
// If we cannot detect it, we still print a less verbose changelog line.
$issue_matches = [];
preg_match_all('!from [a-zA-Z-_0-9]+/([0-9]+)!', $line, $issue_matches);

$log_messages[1] = trim(str_replace('* ', '', $log_messages[1]));
if (isset($issue_matches[1][0])) {
$issue_number = $issue_matches[1][0];
}
}

$pr_number = $pr_matches[1][0];

if (!empty($github_org) && !empty($github_project)) {
/** @var \stdClass $pr_details */
$pr_details = $this->githubApiGet("repos/$github_org/$github_project/pulls/$pr_number");
if (!empty($pr_details->user)) {
if (isset($pr_details->user->type) && $pr_details->user->type === 'Bot') {
// Exclude Dependabot merges from release notes.
continue;
}
$contributors[] = '@' . $pr_details->user->login;
$additions += $pr_details->additions;
$deletions += $pr_details->deletions;
$changed_files += $pr_details->changed_files;

if (empty($log_messages[1])) {
$log_messages[1] = $pr_details->title;
}
}
}
if (empty($issue_number)) {
// Try GraphQL first (linked issues in Development section).
$linked_issues = $this->githubGraphQlGetLinkedIssuesFromPr((int) $pr_number, $github_project, $github_org);
$issue_number = !empty($linked_issues) ? array_key_first($linked_issues) : NULL;

if (empty($log_messages[1])) {
// Whitespace-only log message, not meaningful for changelog.
continue;
}

// The issue number is a required part of the branch name,
// So usually we can grab it from the log too, but that's optional
// If we cannot detect it, we still print a less verbose changelog line.
$issue_matches = [];
preg_match_all('!from [a-zA-Z-_0-9]+/([0-9]+)!', $line, $issue_matches);

if (isset($issue_matches[1][0])) {
$issue_number = $issue_matches[1][0];
}
else {
// Retrieve the issue number from the PR description via GitHub API.
$pr = NULL;
if (!empty($github_project) && !empty($github_org)) {
$pr = $this->githubApiGet("repos/$github_org/$github_project/pulls/$pr_number");
}
if (!isset($pr->body)) {
$no_issue_lines[] = "- $log_messages[1] (#$pr_number)";
continue;
}
preg_match_all('!#([0-9]+)!', $pr->body, $issue_matches);
if (!isset($issue_matches[1][0])) {
$no_issue_lines[] = "- $log_messages[1] (#$pr_number)";
continue;
// Fall back to parsing PR body if GraphQL didn't find anything.
if (empty($issue_number)) {
$issue_number = $this->githubApiGetLinkedIssuesFromPrBody((int) $pr_number, $github_project, $github_org);
}
}
$issue_number = $issue_matches[1][0];
}

if (!empty($issue_number)) {
if (!isset($issue_titles[$issue_number]) && !empty($github_org) && !empty($github_project)) {
if (!empty($issue_number) && !isset($issue_titles[$issue_number])) {
/** @var \stdClass $issue_details */
$issue_details = $this->githubApiGet("repos/$github_org/$github_project/issues/$issue_number");
if (!empty($issue_details->title)) {
$issue_titles[$issue_number] = $issue_details->title;
$contributors[] = '@' . $issue_details->user->login;
}
}
}

if (isset($issue_titles[$issue_number])) {
$issue_line = "- $issue_titles[$issue_number] (#$issue_number)";
}
else {
$issue_line = "- Issue #$issue_number";
if (empty($issue_number)) {
if (!empty($pr_number)) {
$no_issue_lines[] = "- PR #$pr_number";
}
if (!isset($pull_requests_per_issue[$issue_line])) {
$pull_requests_per_issue[$issue_line] = [];
}
$pull_requests_per_issue[$issue_line][] = " - $log_messages[1] (#{$pr_matches[1][0]})";
continue;
}

if (isset($issue_titles[$issue_number])) {
$issue_line = "- $issue_titles[$issue_number] (#$issue_number)";
}
else {
$no_issue_lines[] = "- $log_messages[1] (#$pr_number)";
$issue_line = "- Issue #$issue_number";
}
if (!isset($pull_requests_per_issue[$issue_line])) {
$pull_requests_per_issue[$issue_line] = [];
}
$pull_requests_per_issue[$issue_line][] = " - $line";

}

foreach ($pull_requests_per_issue as $issue_line => $pr_lines) {
Expand Down Expand Up @@ -276,7 +256,6 @@ protected function githubApiGet(string $path) {
curl_setopt($ch, CURLOPT_FOLLOWLOCATION, TRUE);
$result = curl_exec($ch);
$http_code = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);
$result = empty($result) ? NULL : json_decode($result);
if ($http_code == 404) {
throw new \Exception("404 Not Found error encountered while requesting the API path $path. The path either does not exist, or your token does not have sufficient permissions as Github API returns 404 instead of 403. Details: \n" . print_r($result, TRUE));
Expand All @@ -287,4 +266,138 @@ protected function githubApiGet(string $path) {
return $result;
}

/**
* Get linked issues from a Pull Request using GitHub's Development links.
*
* This function uses GitHub's GraphQL API to fetch issues that are
* formally linked to the PR via the "Development" section
* (closingIssuesReferences).
*
* @param int $pr_number
* The pull request number.
* @param string $repo
* Github repo name.
* @param string $owner
* Github user/organization name.
*
* @return array
* An array of linked issues with 'number' and 'title' keys.
*/
protected function githubGraphQlGetLinkedIssuesFromPr(int $pr_number, string $repo, string $owner): array {
$token = getenv('GITHUB_ACCESS_TOKEN');
if (empty($token)) {
return [];
}

$query = <<<'GRAPHQL'
query($owner: String!, $repo: String!, $pr: Int!) {
repository(owner: $owner, name: $repo) {
pullRequest(number: $pr) {
closingIssuesReferences(first: 50) {
nodes {
number
title
repository {
name
owner {
login
}
}
}
}
}
}
}
GRAPHQL;

$payload = json_encode([
'query' => $query,
'variables' => [
'owner' => $owner,
'repo' => $repo,
'pr' => $pr_number,
],
]);

$ch = curl_init('https://api.github.com/graphql');
curl_setopt($ch, CURLOPT_USERAGENT, 'Drupal Starter Release Notes Generator');
Copy link
Collaborator

@mariano-dagostino mariano-dagostino Feb 3, 2026

Choose a reason for hiding this comment

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

Do we need this?

Copy link
Contributor Author

@balagan73 balagan73 Feb 3, 2026

Choose a reason for hiding this comment

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

Same thing we have at line 252.

curl_setopt($ch, CURLOPT_HTTPHEADER, [
'Authorization: bearer ' . $token,
'Content-Type: application/json',
]);
curl_setopt($ch, CURLOPT_POST, TRUE);
curl_setopt($ch, CURLOPT_POSTFIELDS, $payload);
curl_setopt($ch, CURLOPT_TIMEOUT, 30);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, TRUE);

$result = curl_exec($ch);
$http_code = curl_getinfo($ch, CURLINFO_HTTP_CODE);

if ($http_code !== 200 || empty($result)) {
return [];
}

$data = json_decode($result, TRUE);
$linked_issues = $data['data']['repository']['pullRequest']['closingIssuesReferences']['nodes'] ?? [];

$issues = [];
foreach ($linked_issues as $linked_issue) {
// Only include issues from the same repository.
$issue_repo = $linked_issue['repository']['name'] ?? '';
$issue_owner = $linked_issue['repository']['owner']['login'] ?? '';
if ($issue_repo !== $repo || $issue_owner !== $owner) {
continue;
}
Comment on lines +344 to +350
Copy link
Collaborator

@mariano-dagostino mariano-dagostino Feb 3, 2026

Choose a reason for hiding this comment

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

I wonder if this check is really necessary as the graphql already specifies the repo.

Copy link
Contributor Author

@balagan73 balagan73 Feb 3, 2026 •
edited
Loading

Choose a reason for hiding this comment

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

Most probably not, but as an edge case linked issues can be in a different repo. I think it doesn't hurt to have this extra check.


$issue_number = $linked_issue['number'];
$issues[$issue_number] = [
'number' => $issue_number,
'title' => $linked_issue['title'] ?? '',
];
}

return $issues;
}

/**
* Get linked issue from a Pull Request by parsing the PR body.
*
* This function uses GitHub's REST API to fetch the PR details and then
* parses the body to find issue references (e.g., #123 or "Fixes repo#123").
*
* @param int $pr_number
* The pull request number.
* @param string $repo
* Github repo name.
* @param string $owner
* Github user/organization name.
*
* @return string|null
* The issue number as a string, or NULL if not found.
*/
protected function githubApiGetLinkedIssuesFromPrBody(int $pr_number, string $repo, string $owner): ?string {
$pr = $this->githubApiGet("repos/$owner/$repo/pulls/$pr_number");

if (!isset($pr->body)) {
return NULL;
}

$issue_matches = [];

// First try the specific "Fixes" pattern which explicitly indicates issue
// linkage.
preg_match_all('!Fixes .+#([0-9]+)!', $pr->body, $issue_matches);
if (isset($issue_matches[1][0])) {
return $issue_matches[1][0];
}

// Fall back to simple issue reference pattern.
preg_match_all('!#([0-9]+)!', $pr->body, $issue_matches);
if (isset($issue_matches[1][0])) {
return $issue_matches[1][0];
}

return NULL;
}

}
Loading