Skip to content

Migrate GitHub Copilot agent config from .github/copilot-instructions.md to AGENTS.md#58

Merged
lmajano merged 2 commits intodevelopmentfrom
copilot/migrate-to-agents-md-standard
Apr 27, 2026
Merged

Migrate GitHub Copilot agent config from .github/copilot-instructions.md to AGENTS.md#58
lmajano merged 2 commits intodevelopmentfrom
copilot/migrate-to-agents-md-standard

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Apr 27, 2026

GitHub Copilot now supports the AGENTS.md standard, making .github/copilot-instructions.md redundant. This aligns Copilot with the shared AGENTS.md file already used by Codex and OpenCode, reducing duplication.

Core change

models/AgentRegistry.cfccopilot path updated in both AGENT_FILES and getAgentConfigPath():

AGENT_FILES = {
    "claude"   : "CLAUDE.md",
    "copilot"  : "AGENTS.md",   // was: ".github/copilot-instructions.md"
    "cursor"   : ".cursorrules",
    "codex"    : "AGENTS.md",
    "gemini"   : "GEMINI.md",
    "opencode" : "AGENTS.md"
}

Supporting updates

  • commands/coldbox/ai/agents/help.cfc — help text updated to show AGENTS.md (shared) for Copilot
  • AI_INTEGRATION.md — agent table, mermaid diagrams, setup instructions, and agent file list updated; duplicate AGENTS.md entry removed
  • README.md — supported agents list updated
  • changelog.md — new entry added noting that existing .github/copilot-instructions.md files are not auto-removed on coldbox ai refresh

Copilot AI linked an issue Apr 27, 2026 that may be closed by this pull request
Copilot AI changed the title [WIP] Migrate from copilot-instructions to agents.md Migrate GitHub Copilot agent config from .github/copilot-instructions.md to AGENTS.md Apr 27, 2026
Copilot AI requested a review from lmajano April 27, 2026 18:05
@lmajano lmajano marked this pull request as ready for review April 27, 2026 19:37
Copilot AI review requested due to automatic review settings April 27, 2026 19:37
@lmajano lmajano merged commit c9cf090 into development Apr 27, 2026
5 checks passed
@lmajano lmajano deleted the copilot/migrate-to-agents-md-standard branch April 27, 2026 19:37
Copy link
Copy Markdown

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 migrates the GitHub Copilot agent configuration file used by the ColdBox CLI from the legacy .github/copilot-instructions.md location to the newer AGENTS.md standard, aligning Copilot with other agents that already use the shared AGENTS.md file.

Changes:

  • Updated AgentRegistry to map Copilot’s config file to AGENTS.md (and return that path from getAgentConfigPath()).
  • Updated CLI help and documentation to reflect Copilot using AGENTS.md (shared).
  • Added changelog notes about the migration and updated supported-agent listings.

Reviewed changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated 4 comments.

Show a summary per file
File Description
models/AgentRegistry.cfc Switches Copilot config path to AGENTS.md in both the registry mapping and path resolution.
commands/coldbox/ai/agents/help.cfc Updates agent help text to show Copilot uses AGENTS.md (shared).
AI_INTEGRATION.md Updates diagrams/table/setup steps to reflect Copilot using shared AGENTS.md.
README.md Updates supported agents list to reflect Copilot’s new config file location.
changelog.md Adds an Unreleased entry documenting the Copilot → AGENTS.md migration and updates supported agents text.
Comments suppressed due to low confidence (2)

AI_INTEGRATION.md:958

  • This diagram now labels Copilot as "AGENTS.md (shared)" but still shows separate AGENTS.md nodes for Codex/OpenCode. If AGENTS.md is truly shared among these agents, consider modeling them as pointing to the same AGENTS.md node (or labeling Codex/OpenCode nodes as shared too) to prevent confusion.
    subgraph "Agent Configurations"
        Guidelines --> ClaudeConfig["CLAUDE.md"]
        Guidelines --> CopilotConfig["AGENTS.md (shared)"]
        Guidelines --> CursorConfig[".cursorrules"]
        Guidelines --> CodexConfig["AGENTS.md"]
        Guidelines --> GeminiConfig["GEMINI.md"]
        Guidelines --> OpenCodeConfig["AGENTS.md"]

models/AgentRegistry.cfc:29

  • copilot, codex, and opencode now all resolve to the same config path (AGENTS.md). The existing coldbox ai agents remove <agent> implementation deletes the file returned by getAgentConfigPath(), so removing any one of these agents will delete AGENTS.md even if other shared agents remain configured (data loss / unexpected behavior). Consider treating AGENTS.md as a shared resource: only delete it when no remaining configured agents map to it, or never auto-delete shared config files and instead just update the manifest (optionally prompting the user).
		AGENT_FILES = {
			"claude"   : "CLAUDE.md",
			"copilot"  : "AGENTS.md",
			"cursor"   : ".cursorrules",
			"codex"    : "AGENTS.md",
			"gemini"   : "GEMINI.md",
			"opencode" : "AGENTS.md"

Comment thread changelog.md
- GitHub Copilot agent configuration now uses `AGENTS.md` (shared with Codex and OpenCode) instead of `.github/copilot-instructions.md`
- Follows the [Agents.md standard](https://github.blog/changelog/2025-08-28-copilot-coding-agent-now-supports-agents-md-custom-instructions/) now supported by GitHub Copilot
- Provides a single source of truth for Copilot, Codex, and OpenCode agents
- Existing `.github/copilot-instructions.md` files are not removed automatically; run `coldbox ai refresh` to write the updated location
Copy link

Copilot AI Apr 27, 2026

Choose a reason for hiding this comment

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

This bullet is a bit misleading: coldbox ai refresh will create/write the new AGENTS.md location, but it will not remove existing .github/copilot-instructions.md files. Consider rewording to explicitly state that old files must be removed manually if desired.

Suggested change
- Existing `.github/copilot-instructions.md` files are not removed automatically; run `coldbox ai refresh` to write the updated location
- Running `coldbox ai refresh` writes the new `AGENTS.md` location, but any existing `.github/copilot-instructions.md` files are not removed automatically and must be deleted manually if desired

Copilot uses AI. Check for mistakes.
Comment thread changelog.md
##### Multi-Agent Support (6 Agents)

- **Supported Agents**: Claude (`CLAUDE.md`), GitHub Copilot (`.github/copilot-instructions.md`), Cursor (`.cursorrules`), Codex (`AGENTS.md`), Gemini (`GEMINI.md`), OpenCode (`AGENTS.md`)
- **Supported Agents**: Claude (`CLAUDE.md`), GitHub Copilot (`AGENTS.md`, shared), Cursor (`.cursorrules`), Codex (`AGENTS.md`), Gemini (`GEMINI.md`), OpenCode (`AGENTS.md`)
Copy link

Copilot AI Apr 27, 2026

Choose a reason for hiding this comment

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

The "Supported Agents" list marks Copilot as using AGENTS.md (shared) but leaves Codex/OpenCode as just AGENTS.md. Since all three now share the same file, this line should mark Codex and OpenCode as shared as well (or rephrase to avoid inconsistency).

Suggested change
- **Supported Agents**: Claude (`CLAUDE.md`), GitHub Copilot (`AGENTS.md`, shared), Cursor (`.cursorrules`), Codex (`AGENTS.md`), Gemini (`GEMINI.md`), OpenCode (`AGENTS.md`)
- **Supported Agents**: Claude (`CLAUDE.md`), GitHub Copilot (`AGENTS.md`, shared), Cursor (`.cursorrules`), Codex (`AGENTS.md`, shared), Gemini (`GEMINI.md`), OpenCode (`AGENTS.md`, shared)

Copilot uses AI. Check for mistakes.
Comment thread README.md
```

**Supported Agents**: Claude (CLAUDE.md → AGENTS.md), GitHub Copilot (.github/copilot-instructions.md), Cursor (.cursorrules), Codex (AGENTS.md), Gemini (GEMINI.md), OpenCode (AGENTS.md)
**Supported Agents**: Claude (CLAUDE.md → AGENTS.md), GitHub Copilot (AGENTS.md, shared), Cursor (.cursorrules), Codex (AGENTS.md), Gemini (GEMINI.md), OpenCode (AGENTS.md)
Copy link

Copilot AI Apr 27, 2026

Choose a reason for hiding this comment

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

This supported-agents list marks Copilot as using AGENTS.md (shared) but does not indicate that Codex and OpenCode also share AGENTS.md. Update the wording for accuracy/consistency (or phrase it as a single shared AGENTS.md used by multiple agents).

Suggested change
**Supported Agents**: Claude (CLAUDE.md → AGENTS.md), GitHub Copilot (AGENTS.md, shared), Cursor (.cursorrules), Codex (AGENTS.md), Gemini (GEMINI.md), OpenCode (AGENTS.md)
**Supported Agents**: Claude (CLAUDE.md → AGENTS.md), GitHub Copilot/Codex/OpenCode (shared `AGENTS.md`), Cursor (.cursorrules), Gemini (GEMINI.md)

Copilot uses AI. Check for mistakes.
Comment on lines 47 to 50
.yellowLine( "Note: Each agent creates its own configuration file:" )
.line( " Claude: CLAUDE.md" )
.line( " Copilot: .github/copilot-instructions.md" )
.line( " Copilot: AGENTS.md (shared)" )
.line( " Cursor: .cursorrules" )
Copy link

Copilot AI Apr 27, 2026

Choose a reason for hiding this comment

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

The help text says "Each agent creates its own configuration file", but Copilot (and also Codex/OpenCode) now share AGENTS.md. Update this wording to avoid implying one-file-per-agent (e.g., "Agent configuration files:" or explicitly note which agents share AGENTS.md).

Copilot uses AI. Check for mistakes.
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.

Migrate from copilot-instructions to agents.md

3 participants