docs: update APM to use shared/apm.md imported workflow#23877
Conversation
Agent-Logs-Url: https://github.com/github/gh-aw/sessions/802063cc-6bea-4871-9b76-dfcdba6aeddb Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
Updates the documentation to reflect that APM is now configured via importing shared/apm.md, and that the legacy dependencies: frontmatter field is deprecated/unsupported.
Changes:
- Updates the frontmatter reference to show APM configuration via
imports: - uses: shared/apm.mdand adds a deprecation note fordependencies:. - Rewrites the APM Dependencies reference page around the import-based workflow, keeping package reference formats and governance/reproducibility guidance.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| docs/src/content/docs/reference/frontmatter.md | Updates APM section to document the shared/apm.md import approach and adds a deprecation note for dependencies:. |
| docs/src/content/docs/reference/dependencies.md | Reorients APM dependencies documentation around the shared/apm.md imported workflow and updates examples accordingly. |
Comments suppressed due to low confidence (1)
docs/src/content/docs/reference/frontmatter.md:143
- The NOTE says
dependencies:is "deprecated and no longer supported", which is internally inconsistent (deprecated typically implies still supported). Consider rewording to either "deprecated (still supported until <date/version>)" or "removed/no longer supported" to avoid confusing readers about current behavior.
> [!NOTE]
> The `dependencies:` frontmatter field is deprecated and no longer supported. Migrate to the `imports: - uses: shared/apm.md` approach shown above.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| - microsoft/apm-sample-package | ||
| - github/awesome-copilot/skills/review-and-refactor | ||
| - microsoft/apm-sample-package#v2.0 # version-pinned | ||
| ```aw wrap |
There was a problem hiding this comment.
The code fence for this snippet uses aw, but this section is documenting a frontmatter field and the surrounding examples in this file use yaml fences. Consider switching this to a yaml wrap code fence for consistent syntax highlighting on the frontmatter reference page.
This issue also appears on line 142 of the same file.
| ```aw wrap | |
| ```yaml wrap |
|
|
||
| APM lock files (`apm.lock`) pin every package to an exact commit SHA, so the same versions are installed on every run. Lock file diffs appear in pull requests and are reviewable before merge, giving teams and enterprises a clear audit trail and the ability to govern which agent context is in use. See the [APM governance guide](https://microsoft.github.io/apm/enterprise/governance/) for details on policy enforcement and access controls. | ||
| > [!NOTE] | ||
| > The `dependencies:` frontmatter field is deprecated and no longer supported. Migrate to the import-based approach shown below. |
There was a problem hiding this comment.
The NOTE says dependencies: is "deprecated and no longer supported", which is internally inconsistent (deprecated typically implies still supported). Consider rewording to either "deprecated (still supported until <date/version>)" or "removed/no longer supported" to avoid confusing readers about current behavior.
| > The `dependencies:` frontmatter field is deprecated and no longer supported. Migrate to the import-based approach shown below. | |
| > The `dependencies:` frontmatter field has been removed and is no longer supported. Migrate to the import-based approach shown below. |
The
dependencies:frontmatter field for APM is deprecated and no longer supported. APM is now configured by importing theshared/apm.mdagentic workflow.Changes
reference/dependencies.md— Rewrote around the new import-based approach; adds deprecation notice fordependencies:, removes old format sections (simple array, object, GitHub App object), preserves package reference formats and governance contentreference/frontmatter.md— Updated APM section heading and examples to reflect the import syntax; adds deprecation NOTE alert fordependencies:New usage
imports: - uses: shared/apm.md with: packages: - microsoft/apm-sample-package - github/awesome-copilot/skills/review-and-refactor