Fix PR link formatting in cli-version-checker workflow by Copilot · Pull Request #3586 · github/gh-aw

Copilot · 2025-11-11T02:25:32Z

The cli-version-checker workflow creates issues about CLI updates that include PR references from external repositories (openai/codex, github/github-mcp-server). These short references like #6211 incorrectly link to non-existent gh-aw PRs instead of the intended external repository.

Changes

GitHub Release Notes section: Added CRITICAL instructions to convert PR/issue references to full URLs for Codex and GitHub MCP Server
- Codex: #6211 → https://github.com/openai/codex/pull/6211
- GitHub MCP Server: #1105 → https://github.com/github/github-mcp-server/pull/1105
New Pull Request Link Formatting section: Added dedicated guidance with examples
- Documents that #1234 references only work within same repository
- Provides correct/incorrect examples for external repository links
- Instructs to convert references when copying from release notes

Example

When processing Codex release notes, the workflow will now convert:

<!-- Before: ambiguous reference -->
- Fixed authentication bug #6211

<!-- After: explicit external link -->
- Fixed authentication bug https://github.com/openai/codex/pull/6211

Addresses feedback from issue #3571.

Original prompt

This section details on the original issue you should resolve

<issue_title>[q] Fix PR link formatting in cli-version-checker workflow</issue_title>
<issue_description># Q Workflow Optimization Report

Context

This fix addresses feedback from issue #3571 where @pelikhan requested: "/q the workflow should specify that the links to pull requests must use full links as they refer to another repo."

Issue Found (from issue #3571)

The cli-version-checker workflow creates issues about CLI version updates that include pull request references from external repositories (openai/codex, github/github-mcp-server). However, the workflow instructions didn't explicitly specify that PR references like #6211 must be converted to full URLs when they refer to external repositories.

Example from issue #3571:

Issue body contained references like #6211, #6230, #3643, etc.
These are from the openai/codex repository, not githubnext/gh-aw
In the context of issue [ca] Update Codex to 0.57.0 and GitHub MCP Server to v0.20.2 #3571 in githubnext/gh-aw, #6211 would incorrectly link to a non-existent PR in gh-aw

Changes Made

.github/workflows/cli-version-checker.md

1. Enhanced GitHub Release Notes Instructions (lines 68-76)

Added CRITICAL instruction to convert PR/issue references to full URLs for Codex
Added CRITICAL instruction to convert PR/issue references to full URLs for GitHub MCP Server
Specified the exact format: #1234 → https://github.com/owner/repo/pull/1234

2. Added Pull Request Link Formatting Section (lines 127-132)

Created new dedicated section explaining PR link formatting rules
Provided clear CORRECT vs INCORRECT examples
Emphasized that #1234 style references only work within the same repository
Specified when copying from release notes, conversion to full URLs is required

Expected Improvements

✅ Future CLI version update issues will use full URLs for external repo PRs
✅ Links in issues will correctly navigate to the intended external repositories
✅ No more confusion about which repository a PR reference points to
✅ Improved documentation clarity for external repository references

Validation

Changes validated:

✅ Workflow file modified successfully
✅ Git commit created with descriptive message
✅ Changes are minimal and surgical (8 insertions, 1 deletion)
✅ Only modified .md workflow file (no .lock.yml files)

Note: .lock.yml file will be generated automatically after merge via GitHub Actions.

References

Triggering issue: [ca] Update Codex to 0.57.0 and GitHub MCP Server to v0.20.2 #3571
Triggering comment: [ca] Update Codex to 0.57.0 and GitHub MCP Server to v0.20.2 #3571 (comment)
Workflow run: https://github.com/githubnext/gh-aw/actions/runs/19252731392

AI generated by Q

[!NOTE]
This was originally intended as a pull request, but the git push operation failed.

Workflow Run: View run details and download patch artifact

The patch file is available as an artifact (aw.patch) in the workflow run linked above.
To apply the patch locally:

# Download the artifact from the workflow run https://github.com/githubnext/gh-aw/actions/runs/19252731392
# (Use GitHub MCP tools if gh CLI is not available)
gh run download 19252731392 -n aw.patch
# Apply the patch
git am aw.patch

Show patch preview (46 of 46 lines)

From 1f74efe1238856e4777024d70ae1068caebd2fda Mon Sep 17 00:00:00 2001
From: "github-actions[bot]" <github-actions[bot]@users.noreply.github.com>
Date: Tue, 11 Nov 2025 02:21:17 +0000
Subject: [PATCH] Fix PR link formatting in cli-version-checker workflow

- Add explicit instruction to convert PR references to full URLs
- Clarify that githubnext/gh-aw#1234 style references only work for same repo
- Specify correct format for external repo PRs
- Addresses feedback from issue githubnext/gh-aw#3571
---
 .github/workflows/cli-version-checker.md | 9 ++++++++-
 1 file changed, 8 insertions(+), 1 deletion(-)

diff --git a/.github/workflows/cli-version-checker.md b/.github/workflows/cli-version-checker.md
index ff260ac..cb85ce3 100644
--- a/.github/workflows/cli-version-checker.md
+++ b/.github/workflows/cli-version-checker.md
@@ -69,9 +69,10 @@ For each update, analyze intermediate versions:
 - **Codex**: Fetch release notes from https://github.com/openai/codex/releases/tag/rust-v{VERSION}
   - Parse the "Highlights" section for key changes
   - Parse the "PRs merged" or "Merged PRs" section for detailed changes
-  - Extract links to pull requests and issues for context
+  - **CRITICAL**: Convert PR/issue references (e.g., `#6211`) to full URLs since they refer to external repositories (e.g., `https://github.com/openai/codex/pull/6211`)
 - **GitHub MCP Server**: Fetch release notes from https://github.com/github/github-mcp-server/releases/tag/v{VE...

</details>

- Fixes githubnext/gh-aw#3582

<!-- START COPILOT CODING AGENT TIPS -->
---

✨ Let Copilot coding agent [set things up for you](https://github.com/githubnext/gh-aw/issues/new?title=✨+Set+up+Copilot+instructions&body=Configure%20instructions%20for%20this%20repository%20as%20documented%20in%20%5BBest%20practices%20for%20Copilot%20coding%20agent%20in%20your%20repository%5D%28https://gh.io/copilot-coding-agent-tips%29%2E%0A%0A%3COnboard%20this%20repo%3E&assignees=copilot) — coding agent works faster and does higher quality work when set up for your repo.

Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>

Copilot

Pull Request Overview

This PR addresses a documentation issue where the cli-version-checker workflow was creating issues with ambiguous PR/issue references (like #6211) that incorrectly linked to the gh-aw repository instead of external repositories (openai/codex, github/github-mcp-server). The fix adds explicit instructions to convert these short references to full URLs.

Key changes:

Added CRITICAL instructions in the "GitHub Release Notes" section for Codex and GitHub MCP Server to convert short PR references to full URLs
Added a new "Pull Request Link Formatting" section with clear examples of correct vs incorrect formatting

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.

File	Description
`.github/workflows/cli-version-checker.md`	Added instructions to convert PR/issue references to full URLs in two sections: GitHub Release Notes (lines 72, 75) and new Pull Request Link Formatting section (lines 128-132)
`.github/workflows/cli-version-checker.lock.yml`	Auto-generated compiled version reflecting the same changes as the .md file

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2025-11-11T02:41:32Z

.github/workflows/cli-version-checker.md

+  - **CRITICAL**: Convert PR/issue references (e.g., `#6211`) to full URLs since they refer to external repositories (e.g., `https://github.com/openai/codex/pull/6211`)
 - **GitHub MCP Server**: Fetch release notes from https://github.com/github/github-mcp-server/releases/tag/v{VERSION}
  - Parse release body for changelog entries
+  - **CRITICAL**: Convert PR/issue references (e.g., `#1105`) to full URLs since they refer to external repositories (e.g., `https://github.com/github/github-mcp-server/pull/1105`)


The instruction mentions 'PR/issue references' but only provides an example URL format for pull requests (/pull/). Consider adding an example for issue references as well (e.g., https://github.com/openai/codex/issues/1234) to cover both cases mentioned in the text.

Suggested change

- **CRITICAL**: Convert PR/issue references (e.g., `#6211`) to full URLs since they refer to external repositories (e.g., `https://github.com/openai/codex/pull/6211`)

- **GitHub MCP Server**: Fetch release notes from https://github.com/github/github-mcp-server/releases/tag/v{VERSION}

- Parse release body for changelog entries

- **CRITICAL**: Convert PR/issue references (e.g., `#1105`) to full URLs since they refer to external repositories (e.g., `https://github.com/github/github-mcp-server/pull/1105`)

- **CRITICAL**: Convert PR/issue references (e.g., `#6211`) to full URLs since they refer to external repositories (e.g., `https://github.com/openai/codex/pull/6211` for PRs, `https://github.com/openai/codex/issues/1234` for issues)

- **GitHub MCP Server**: Fetch release notes from https://github.com/github/github-mcp-server/releases/tag/v{VERSION}

- Parse release body for changelog entries

- **CRITICAL**: Convert PR/issue references (e.g., `#1105`) to full URLs since they refer to external repositories (e.g., `https://github.com/github/github-mcp-server/pull/1105` for PRs, `https://github.com/github/github-mcp-server/issues/1105` for issues)

Copilot · 2025-11-11T02:41:33Z

.github/workflows/cli-version-checker.md

+- **CRITICAL**: Always use full URLs for pull requests that refer to external repositories
+- **CORRECT**: https://github.com/openai/codex/pull/6211
+- **INCORRECT**: #6211 (relative reference only works for same repository)
+- When copying PR references from release notes, convert `#1234` to full URLs like `https://github.com/owner/repo/pull/1234`


For consistency with line 72 and 75, this instruction should also mention issue references in addition to PR references, and use 'PR/issue references' to match the terminology used earlier in the document.

Suggested change

- When copying PR references from release notes, convert `#1234` to full URLs like `https://github.com/owner/repo/pull/1234`

- When copying PR/issue references from release notes, convert `#1234` to full URLs like `https://github.com/owner/repo/pull/1234` for PRs or `https://github.com/owner/repo/issues/1234` for issues

Initial plan

b84c8b6

Copilot AI assigned Copilot and pelikhan Nov 11, 2025

Copilot started work on behalf of pelikhan November 11, 2025 02:26 View session

Copilot AI and others added 2 commits November 11, 2025 02:32

Initial plan for PR link formatting fix

158aabd

Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>

Regenerate lock file with PR link formatting instructions

6596e98

Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>

Copilot AI changed the title ~~[WIP] Fix PR link formatting in cli-version-checker workflow~~ Fix PR link formatting in cli-version-checker workflow Nov 11, 2025

Copilot AI requested a review from pelikhan November 11, 2025 02:38

Copilot finished work on behalf of pelikhan November 11, 2025 02:38

pelikhan approved these changes Nov 11, 2025

View reviewed changes

pelikhan marked this pull request as ready for review November 11, 2025 02:39

Copilot AI review requested due to automatic review settings November 11, 2025 02:39

pelikhan merged commit 0f88d4c into main Nov 11, 2025
4 checks passed

pelikhan deleted the copilot/fix-pr-link-formatting branch November 11, 2025 02:39

Copilot started reviewing on behalf of pelikhan November 11, 2025 02:40 View session

Copilot finished reviewing on behalf of pelikhan November 11, 2025 02:41

Copilot AI reviewed Nov 11, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix PR link formatting in cli-version-checker workflow#3586

Fix PR link formatting in cli-version-checker workflow#3586
pelikhan merged 3 commits intomainfrom
copilot/fix-pr-link-formatting

Copilot AI commented Nov 11, 2025 •

edited

Loading

Uh oh!

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Nov 11, 2025

Uh oh!

Copilot AI Nov 11, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

	- When copying PR references from release notes, convert `#1234` to full URLs like `https://github.com/owner/repo/pull/1234`
	- When copying PR/issue references from release notes, convert `#1234` to full URLs like `https://github.com/owner/repo/pull/1234` for PRs or `https://github.com/owner/repo/issues/1234` for issues

Conversation

Copilot AI commented Nov 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Changes

Example

Context

Issue Found (from issue #3571)

Changes Made

.github/workflows/cli-version-checker.md

Expected Improvements

Validation

References

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI Nov 11, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 11, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Copilot AI commented Nov 11, 2025 •

edited

Loading