Fix NPM package URL template to prevent broken markdown links#3357
Fix NPM package URL template to prevent broken markdown links#3357
Conversation
Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
There was a problem hiding this comment.
Pull Request Overview
This pull request enhances the CLI version checker workflow by adding a dedicated "Changelog Links" section to the issue template. The change improves documentation by providing explicit placeholders for NPM package URLs, repository links, and changelog URLs that were previously only mentioned in the summary list.
Key Changes:
- Adds a new "Changelog Links" section to the issue template with structured link placeholders
- Maintains consistency between the markdown workflow file and its compiled YAML lock file
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
.github/workflows/cli-version-checker.md |
Adds "Changelog Links" section with NPM package, repository, and changelog URL placeholders to the issue template |
.github/workflows/cli-version-checker.lock.yml |
Mirrors the template changes from the markdown file in the compiled workflow YAML |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| - Migration: [Yes/No - details if yes] | ||
|
|
||
| ## Changelog Links | ||
| - **NPM Package**: https://www.npmjs.com/package/@package-name |
There was a problem hiding this comment.
The placeholder '@package-name' in the NPM Package URL should be more specific to match the actual packages monitored by this workflow. Consider using a more descriptive placeholder like '[package-name]' or providing examples like '@anthropic-ai/claude-code', '@github/copilot', '@openai/codex', or 'github/github-mcp-server' to align with the Version Sources documented in lines 48-52.
| - **NPM Package**: https://www.npmjs.com/package/@package-name | |
| - **NPM Package**: https://www.npmjs.com/package/[package-name] |
The CLI version checker template was generating NPM package URLs with backticks around the package name (e.g.,
https://www.npmjs.com/package/@anthropic-ai/claude-code``), breaking markdown links in generated issues.Changes
## Changelog Linkssection to template showing correct URL formathttps://www.npmjs.com/package/@package-name.mdsource and.lock.ymlcompiled workflowBefore
AI inferred formatting, added backticks around package names.
After
Explicit template prevents ambiguity.
Original prompt
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.