Skip to content

docs: clarify apm_modules is derived - #2601

Open
Aryan Singh K. (aryansk) wants to merge 1 commit into
microsoft:mainfrom
aryansk:docs/2064-apm-modules-derived
Open

docs: clarify apm_modules is derived#2601
Aryan Singh K. (aryansk) wants to merge 1 commit into
microsoft:mainfrom
aryansk:docs/2064-apm-modules-derived

Conversation

@aryansk

Copy link
Copy Markdown

Closes #2064

Summary

  • document that apm_modules/ is derived and can be safely gitignored
  • distinguish the committed lockfile/source manifest from regenerable installed content
  • document the reinstall pattern for CI without inventing a currently unsupported persistence flag

Validation

  • documentation-only change; patch syntax was checked against current main

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Note

Copilot was unable to run its full agentic suite in this review.

Adds documentation clarifying that apm_modules/ is a derived, recreatable install directory and should typically be ignored in version control, positioning the lockfile as the durable source of truth.

Changes:

  • Documented that apm_modules/ is derived from apm.yml + apm.lock.yaml and can be regenerated via apm install
  • Added a recommended .gitignore entry for apm_modules/
  • Noted CI/ephemeral workflow guidance and current lack of an automatic post-install cleanup flag

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

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.

apm.yml + apm.lock.yaml + apm_modules left after installation

2 participants