docs: add 'copilot' as primary target name in docs and action.yml#7
Merged
Conversation
Contributor
There was a problem hiding this comment.
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.ymlinput description to listcopilotfirst. - Update
README.mdexamples and inputs table to use/listcopilotas 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 theactions/upload-artifact@v4step appears to have been removed. Reintroduce the upload-artifact step (with its own- uses:) so the secondwith: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
94d9cd9 to
1a31b90
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Align apm-action docs and action.yml with microsoft/apm#228 —
copilotis now the recommended user-facing target name for the GitHub Copilot / Cursor / Codex / Gemini output format.vscoderemains valid as an alias.Changes
copilotfirsttarget: 'copilot', inputs table showscopilotas primaryNo behavior changes — the action passes the target string through to
apm pack --target, and APM CLI handles the alias mapping.