Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1,071 changes: 682 additions & 389 deletions docs/public/editor/autocomplete-data.json

Large diffs are not rendered by default.

5 changes: 0 additions & 5 deletions docs/src/content/docs/reference/dependencies.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,6 @@ sidebar:

APM is configured by importing the `shared/apm.md` workflow, which creates a dedicated `apm` job that packs packages and uploads the bundle as a GitHub Actions artifact. The agent job then downloads and unpacks the bundle for deterministic startup.

> [!NOTE]
> The `dependencies:` frontmatter field is deprecated and no longer supported. Migrate to the import-based approach shown below.
>
> The `dependencies:` input on the underlying `microsoft/apm-action` (used inside `shared/apm.md`) is also deprecated in favour of the `packages:` and `apps:` inputs — do not reach for `dependencies:` when hand-editing a vendored copy of the file.

## Where `shared/apm.md` comes from

`shared/apm.md` is a **local workflow file** that gh-aw resolves at `.github/workflows/shared/apm.md` in your repository — it is not a remote import (the `uses:` syntax inside `imports:` is gh-aw's local-import shape, not GitHub Actions' `uses: owner/repo@ref`).
Expand Down
45 changes: 11 additions & 34 deletions docs/src/content/docs/reference/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -129,49 +129,26 @@ Usually, yes. If your agent can do it, agentic workflows can usually do it too,

For reusable packaging, start with [imports](/gh-aw/reference/imports/) and [APM (Agent Package Manager)](https://microsoft.github.io/apm/). Imports are a good fit for sharing workflow-level configuration and prompts, while APM is the recommended way to package and distribute skills and other agent primitives. See [APM Dependencies](/gh-aw/reference/dependencies/) for the gh-aw integration.

### The `plugins:` field I was using is gone - how do I install agent plugins now?
### The `plugins:` or `dependencies:` field I was using is gone - how do I install agent plugins now?

The `plugins:` frontmatter field has been removed in favour of the `dependencies:` field backed by [Microsoft APM (Agent Package Manager)](https://microsoft.github.io/apm/). APM provides cross-agent support for all agent primitives – skills, prompts, instructions, hooks, and plugins (including the Copilot `plugin.json` format and the Claude `plugin.json` format).
The `plugins:` and `dependencies:` frontmatter fields have been removed in favour of the import-based approach backed by [Microsoft APM (Agent Package Manager)](https://microsoft.github.io/apm/). APM provides cross-agent support for all agent primitives – skills, prompts, instructions, hooks, and plugins (including the Copilot `plugin.json` format and the Claude `plugin.json` format).

Run `gh aw fix --write` to automatically migrate your existing `plugins:` fields to `dependencies:`.

Use the `dependencies:` field in your workflow frontmatter to install plugins:
Use `imports: - uses: shared/apm.md` with the `packages:` parameter to install plugins:

Comment on lines +132 to 137
```yaml wrap
# Simple list (public or same-org packages)
dependencies:
- github/my-copilot-plugin
- github/awesome-copilot/plugins/context-engineering
```

For cross-org private packages, use `github-app:` authentication:

```yaml wrap
dependencies:
github-app:
client-id: ${{ vars.APP_ID }}
private-key: ${{ secrets.APP_PRIVATE_KEY }}
packages:
- acme-org/acme-plugins
imports:
- uses: shared/apm.md
with:
packages:
- microsoft/apm-sample-package
- github/awesome-copilot/skills/review-and-refactor
```

The `dependencies:` approach works with all supported engines (Copilot, Claude, Codex, Gemini, Crush), whereas the old `plugins:` field was limited to the Copilot engine only.

See [APM Dependencies](/gh-aw/reference/dependencies/) for full configuration options.

### Can I use Claude plugins with APM dependencies?

Yes! APM supports Claude plugins in the `plugin.json` format. When `engine: claude` is set, APM automatically infers the engine target and unpacks only Claude-compatible primitives. Use `#tag` or `#branch` suffixes to pin specific versions:

```yaml wrap
engine: claude

dependencies:
- owner/repo/plugins/my-plugin#v2.0 # pinned to a tag
- owner/repo/plugins/my-plugin#main # pinned to a branch
```
### Can I use Claude plugins with APM?

For private cross-org plugins and other configuration options, see [APM Dependencies](/gh-aw/reference/dependencies/).
Yes! APM supports Claude plugins in the `plugin.json` format. When `engine: claude` is set, APM automatically infers the engine target and unpacks only Claude-compatible primitives. See [APM Dependencies](/gh-aw/reference/dependencies/) for details.

### Can workflows be broken up into shareable components?

Expand Down
Loading