Conversation
Add explicit URL formatting rules to prevent AI from adding backticks to package names within URLs. This fixes the issue where URLs like https://www.npmjs.com/package/@anthropic-ai/claude-code were being generated with extra backticks as https://www.npmjs.com/package/`@anthropic-ai/claude-code`. Changes: - Updated "Changelog Links" description from "NPM/GitHub release notes" to "Use plain URLs without backticks" - Added new "URL Formatting Rules" section with explicit instructions: - Use plain URLs without backticks - Do NOT use backticks in URLs - Package names in URLs should not be wrapped in backticks Fixes #3356 Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
There was a problem hiding this comment.
Pull Request Overview
This PR updates the documentation for the CLI version checker workflow to clarify URL formatting rules in issue creation. The change explicitly instructs the AI agent to use plain URLs without backticks when creating changelog links in issues.
Key Changes:
- Updated instruction for "Changelog Links" to specify plain URLs without backticks
- Added a new "URL Formatting Rules" section with explicit examples and prohibitions
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 |
Updated documentation to clarify URL formatting rules for issue creation |
.github/workflows/cli-version-checker.lock.yml |
Compiled workflow file with the same documentation updates |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| - **CLI Changes**: New commands, flags, or removed features discovered via help | ||
|
|
||
| **URL Formatting Rules**: | ||
| - Use plain URLs: `https://www.npmjs.com/package/@package-name` |
There was a problem hiding this comment.
The example URL uses backticks around the URL, which contradicts the instruction 'Do NOT use backticks in URLs' on line 102. This should show the URL without any backticks to be consistent with the formatting rules being described.
| - Use plain URLs: `https://www.npmjs.com/package/@package-name` | |
| - Use plain URLs: https://www.npmjs.com/package/@package-name |
| - **CLI Changes**: New commands, flags, or removed features discovered via help | ||
|
|
||
| **URL Formatting Rules**: | ||
| - Use plain URLs: `https://www.npmjs.com/package/@package-name` |
There was a problem hiding this comment.
The example URL uses backticks around the URL, which contradicts the instruction 'Do NOT use backticks in URLs' on line 1302. This should show the URL without any backticks to be consistent with the formatting rules being described.
| - Use plain URLs: `https://www.npmjs.com/package/@package-name` | |
| - Use plain URLs: https://www.npmjs.com/package/@package-name |
The CLI version checker workflow was generating malformed NPM package URLs with backticks inside the URL path, producing broken links like
https://www.npmjs.com/package/@anthropic-ai/claude-code`` instead ofhttps://www.npmjs.com/package/@anthropic-ai/claude-code.Changes
Added explicit URL formatting constraints to
.github/workflows/cli-version-checker.md:The template structure already showed the correct format (
https://www.npmjs.com/package/@package-name), but the AI agent required explicit negative constraints to avoid wrapping the package name in backticks.Fixes #3356
Original prompt
This section details on the original issue you should resolve
<issue_title>[q] Fix NPM package URL template in cli-version-checker</issue_title>
<issue_description># Q Workflow Optimization Report
Issue Analysis
Issue #3356: NPM Package URL Format Error
Triggering Comment: "/q fix template for npm packages URLs (extra ')"
Problem Identified:
The CLI version checker workflow was generating issue descriptions with malformed NPM package URLs containing extra backticks:
This occurred in issue #3356 at line 123 of the generated issue body:
The extra backtick after
package/created a broken URL format.Root Cause
The workflow instructions in
cli-version-checker.mddid not provide explicit guidance on URL formatting in the issue template. The AI agent generating the issue description was inadvertently adding backticks to package names within URLs.Changes Made
.github/workflows/cli-version-checker.md
Added explicit URL formatting instructions in the "Issue Format" section:
Example Before/After
Before:
After:
Expected Improvements
Validation
Workflow compiled successfully:
References
.github/workflows/cli-version-checker.mdThis is a targeted fix that addresses the specific template formatting issue identified in issue #3356. The change is minimal and surgical, focusing only on clarifying URL formatting rules to prevent future occurrences of this problem.
Show patch preview (72 of 72 lines)