Skip to content

Skip AGENTS.md in replacePlaceholder to preserve comet-starter URLs#1362

Draft
dkarnutsch with Copilot wants to merge 2 commits into
mainfrom
copilot/fix-references-in-agents-md
Draft

Skip AGENTS.md in replacePlaceholder to preserve comet-starter URLs#1362
dkarnutsch with Copilot wants to merge 2 commits into
mainfrom
copilot/fix-references-in-agents-md

Conversation

Copilot AI commented Mar 29, 2026

Copy link
Copy Markdown
Contributor

When npx @comet/create-app scaffolds a new project, it replaces all occurrences of starter/Starter with the project name. AGENTS.md contains hardcoded GitHub URLs referencing comet-starter in its References section — these are correctly pointing at the template repo and must not be replaced.

Change

  • create-app/src/util/replacePlaceholder.ts: Add an early-return guard for AGENTS.md, skipping it entirely from placeholder substitution — consistent with the existing special-case handling for intl-update.sh.
if (file.endsWith("AGENTS.md")) {
    return;
}

Without this, URLs like https://api.github.com/repos/vivid-planet/comet-starter/contents/{path} would be rewritten to use the project name, breaking all starter repo references in AI agent guidance.

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

  • iojs.org
    • Triggering command: /usr/bin/curl curl -q --fail --compressed -L -s REDACTED -o - (dns block)

If you need me to access, download, or install something from one of these locations, you can either:


📍 Connect Copilot coding agent with Jira, Azure Boards or Linear to delegate work to Copilot in one click without leaving your project management tool.

Copilot AI changed the title [WIP] Fix invalid links in Agents.md references section Skip AGENTS.md in replacePlaceholder to preserve comet-starter URLs Mar 29, 2026
Copilot AI requested a review from dkarnutsch March 29, 2026 11:15
@dkarnutsch

Copy link
Copy Markdown
Contributor

@thomasdax98 @johnnyomair I'm not really happy with the solution. What do you think?

@johnnyomair johnnyomair left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

@thomasdax98 @johnnyomair I'm not really happy with the solution. What do you think?

Why? Because of generally excluding AGENTS.md? If yes, an alternative would be to change the placeholder regex to not replace starter if it's part of https://github.com/vivid-planet/comet-starter.

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