Skip to content

Conversation

@aaronpowell
Copy link
Contributor

@aaronpowell aaronpowell commented Jul 3, 2025

  • Adding badges
  • Adding links to easy-install into vscode/insiders

Merge blocked as file protocol handlers aren't supported on GitHub READMEs, we need to wait for a redirect link.

This does mean that the layout of the readme needs a change, moving to a table layout so that we keep better alighnment
Copilot AI review requested due to automatic review settings July 3, 2025 02:42
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR adds VS Code and VS Code Insiders install badges to both the generated instructions in the code and the static listings in README.md.

  • Introduces makeBadges(link) to generate markdown badges for installation.
  • Refactors generateInstructionsSection, generatePromptsSection, and generateChatModesSection to output tables including an “Install” column.
  • Updates README.md to replace bulleted lists with tables that include the new install badges.

Reviewed Changes

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

File Description
update-readme.js Added makeBadges function and updated generators to include a table “Install” column using badges.
README.md Replaced list entries with markdown tables for instructions, prompts, and chat modes including install badges.
Comments suppressed due to low confidence (4)

update-readme.js:261

  • [nitpick] The alt text for the second badge is identical to the first (Install in VS Code). Consider labeling it Install in VS Code Insiders to accurately describe the badge.
  return `[![Install in VS Code](https://img.shields.io/badge/VS_Code-Install-0098FF?style=flat-square&logo=visualstudiocode&logoColor=white)](vscode:chat-prompt/install?url=https://raw.githubusercontent.com/github/awesome-copilot/main/${link}) [![Install in VS Code](https://img.shields.io/badge/VS_Code_Insiders-Install-24bfa5?style=flat-square&logo=visualstudiocode&logoColor=white)](vscode-insiders:chat-prompt/install?url=https://raw.githubusercontent.com/github/awesome-copilot/main/${link})`;

update-readme.js:290

  • The variable link is not defined in this scope before calling makeBadges(link). You need to compute or pass the correct relative file path (e.g., const link = ...) before generating badges.
    const badges = makeBadges(link);

update-readme.js:331

  • The variable link is undefined here as well. Ensure you define link (for example const link = path.join('prompts', file)) before generating badges.
    const badges = makeBadges(link);

update-readme.js:380

  • link is not declared in this function’s scope. Define link (e.g., const link = path.join('chatmodes', file)) before calling makeBadges.
    const badges = makeBadges(link);

@aaronpowell aaronpowell marked this pull request as draft July 3, 2025 03:59
@aaronpowell aaronpowell changed the title Install links in readme [NOMERGE] Install links in readme Jul 3, 2025
@aaronpowell aaronpowell marked this pull request as ready for review July 4, 2025 00:54
@aaronpowell aaronpowell changed the title [NOMERGE] Install links in readme Install links in readme Jul 4, 2025
@aaronpowell aaronpowell merged commit 1ca04dc into main Jul 4, 2025
4 checks passed
@aaronpowell aaronpowell deleted the auto-install-links branch July 4, 2025 01:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants