Skip to content

docs: add 'copilot' as primary target name in docs and action.yml#7

Merged
danielmeppiel merged 1 commit into
mainfrom
feat/copilot-target-alias
Mar 10, 2026
Merged

docs: add 'copilot' as primary target name in docs and action.yml#7
danielmeppiel merged 1 commit into
mainfrom
feat/copilot-target-alias

Conversation

@danielmeppiel
Copy link
Copy Markdown
Collaborator

Summary

Align apm-action docs and action.yml with microsoft/apm#228copilot is now the recommended user-facing target name for the GitHub Copilot / Cursor / Codex / Gemini output format. vscode remains valid as an alias.

Changes

  • action.yml: Target input description lists copilot first
  • README.md: Examples use target: 'copilot', inputs table shows copilot as primary

No behavior changes — the action passes the target string through to apm pack --target, and APM CLI handles the alias mapping.

Copilot AI review requested due to automatic review settings March 10, 2026 14:44
Copy link
Copy Markdown
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

Updates the user-facing documentation and Action metadata to recommend copilot as the primary target name (with vscode remaining a valid alias), aligning with the updated APM CLI guidance.

Changes:

  • Update action.yml input description to list copilot first.
  • Update README.md examples and inputs table to use/list copilot as the primary target.

Reviewed changes

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

File Description
action.yml Updates the target input description to recommend copilot first.
README.md Switches examples and the inputs table to target: 'copilot'.
Comments suppressed due to low confidence (2)

README.md:46

  • The README “Pack mode” workflow snippet is invalid YAML now: it has two with: blocks in a single step, and the actions/upload-artifact@v4 step appears to have been removed. Reintroduce the upload-artifact step (with its own - uses:) so the second with: belongs to that step.

This issue also appears on line 72 of the same file.

```yaml
- uses: microsoft/apm-action@v1
  id: pack
  with:
    pack: 'true'
    target: 'copilot'
  with:
    name: agent-bundle
    path: ${{ steps.pack.outputs.bundle-path }}
**README.md:80**
* The “Cross-job artifact workflow” snippet has the same YAML issue: after setting `target: 'copilot'`, the next `with:` block is indented as if it belongs to the same step, but it should be under an `- uses: actions/upload-artifact@v4` step. As written, the example won’t parse/copy-paste correctly.
  - uses: microsoft/apm-action@v1
    id: pack
    with:
      pack: 'true'
      target: 'copilot'
    with:
      name: agent-bundle
      path: ${{ steps.pack.outputs.bundle-path }}
</details>



---

💡 <a href="/microsoft/apm-action/new/main?filename=.github/instructions/*.instructions.md" class="Link--inTextBlock" target="_blank" rel="noopener noreferrer">Add Copilot custom instructions</a> for smarter, more guided reviews. <a href="https://docs.github.com/en/copilot/customizing-copilot/adding-repository-custom-instructions-for-github-copilot" class="Link--inTextBlock" target="_blank" rel="noopener noreferrer">Learn how to get started</a>.

Align with microsoft/apm#228 — 'copilot' is now the recommended
user-facing target name. 'vscode' remains valid as an alias.

- action.yml: target description lists copilot first
- README.md: examples and inputs table show copilot as primary
@danielmeppiel danielmeppiel force-pushed the feat/copilot-target-alias branch from 94d9cd9 to 1a31b90 Compare March 10, 2026 14:46
@danielmeppiel danielmeppiel merged commit b536a90 into main Mar 10, 2026
11 checks passed
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.

2 participants