Fix npm URL format in cli-version-checker workflow#3496
Merged
Conversation
- Enhanced URL Formatting Rules section with explicit CORRECT/INCORRECT examples - Changed "Changelog Links" heading to "Package Links" - Changed placeholder from @package-name to package-name-here - Removes @ symbol to avoid confusion with scoped packages - Prevents AI from wrapping package names with backticks in URLs Fixes #3482 Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Fix npm URL format in cli-version-checker workflow
Fix npm URL format in cli-version-checker workflow
Nov 8, 2025
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR improves the documentation for URL formatting rules in the CLI version checker workflow. The changes clarify how to format URLs correctly by using concrete examples instead of abstract descriptions, and updates the section heading from "Changelog Links" to the more accurate "Package Links".
Key Changes
- Enhanced URL formatting rules with concrete CORRECT/INCORRECT examples to prevent backtick misuse
- Renamed "Changelog Links" section to "Package Links" for better accuracy
- Simplified placeholder text from
@package-nametopackage-name-herefor clarity
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| .github/workflows/cli-version-checker.md | Updated documentation with clearer URL formatting rules, concrete examples, and corrected section heading |
| .github/workflows/cli-version-checker.lock.yml | Synchronized changes from the source workflow file to the compiled lock file |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
The cli-version-checker workflow was generating malformed npm URLs with backticks around package names. The AI agent interpreted the
@package-nameplaceholder as code that should be wrapped with markdown backticks, producing URLs like:Instead of:
Changes
Enhanced URL formatting guidance (lines 100-104):
https://www.npmjs.com/package/@github/copilotUpdated template placeholder (lines 119-120):
@package-namewithpackage-name-hereto prevent backtick wrappingThe
@symbol in the original placeholder triggered markdown formatting interpretation, causing the AI to treat package names as inline code.Fixes #3482
Original prompt
This section details on the original issue you should resolve
<issue_title>[q] Fix npm URL format in cli-version-checker workflow</issue_title>
<issue_description># Q Workflow Optimization Report
Issue Found
Workflow: cli-version-checker
Issue Number: #3482
Problem: The workflow was generating npm URLs with backticks around package names, resulting in malformed URLs like:
Instead of the correct format:
Root Cause
The issue template in the workflow prompt used
@package-nameas a placeholder, which the AI interpreted as needing backticks for code formatting when substituting actual package names.Changes Made
.github/workflows/cli-version-checker.mdEnhanced URL Formatting Rules (lines 100-105):
Updated Template Section (lines 117-120):
@package-nametopackage-name-here@symbol to avoid confusion with scoped packagesExpected Improvements
Validation
✅ Workflow compiled successfully using
gh aw compile cli-version-checker✅ No compilation errors or warnings
✅ Changes are minimal and surgical - only affecting the problematic template section
Note: .lock.yml file will be regenerated automatically after merge.
References
Show patch preview (53 of 53 lines)
@@ -115,9 +117,9 @@ Template structure:
-## Changelog Links
-- NPM Package: https://www.npmjs.com/package/@package-name
-- Repository: [GitHub URL if available]
+### Package Links
+- NPM Package: https://www.npmjs.com/package/package-name-here
+- Repository: [URL to repository if available]
... (truncated)