docs: clarify that .github/ deployed files should be committed#290
Merged
danielmeppiel merged 3 commits intomainfrom Mar 13, 2026
Merged
docs: clarify that .github/ deployed files should be committed#290danielmeppiel merged 3 commits intomainfrom
danielmeppiel merged 3 commits intomainfrom
Conversation
Expand the quick-start 'What to commit' section to explicitly address .github/ and .claude/ deployed files, and add a CI drift check example to the CI/CD guide. Closes #288 Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
Pull request overview
This PR clarifies the recommended Git workflow for APM’s deployed integration files by explicitly documenting that .github/ and .claude/ outputs should be committed (not gitignored), and adds a CI drift-check pattern to keep those files in sync with apm.yml.
Changes:
- Update Quick Start “What to commit” guidance to include
.github/and.claude/deployed files and add a CI drift-check tip. - Add a “Verify Deployed Primitives” section to the CI/CD guide with an example drift-check step.
- Extend CI/CD best-practices bullets to recommend committing deployed integration files.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| docs/src/content/docs/integrations/ci-cd.md | Adds a deployed-primitives drift check snippet and updates best-practice guidance to commit .github//.claude/ outputs. |
| docs/src/content/docs/getting-started/quick-start.md | Expands “What to commit” to explicitly include .github//.claude/ deployed files and links to CI drift checks. |
Comments suppressed due to low confidence (1)
docs/src/content/docs/integrations/ci-cd.md:75
- This workflow step may fail in repos that don’t use Claude integration because
.claude/may not exist afterapm install, andgit diff ... .claude/can error on a missing pathspec. Consider guarding the.claude/check (only include it if the directory exists) and usinggit diff --exit-code -- <paths>to disambiguate paths.
apm install
git diff --exit-code .github/ .claude/ || \
(echo "APM integration files are out of date. Run 'apm install' and commit." && exit 1)
Comment on lines
+72
to
+75
| run: | | ||
| apm install | ||
| git diff --exit-code .github/ .claude/ || \ | ||
| (echo "APM integration files are out of date. Run 'apm install' and commit." && exit 1) |
Comment on lines
+129
to
+131
| - `.github/` deployed files (`prompts/`, `agents/`, `instructions/`, `skills/`, `hooks/`) — commit them so every contributor (and [Copilot on github.com](https://docs.github.com/en/copilot)) gets agent context without running `apm install`. | ||
| - `.claude/` deployed files (`agents/`, `commands/`, `skills/`, `hooks/`) — same rationale, for Claude Code users. | ||
| - `apm_modules/` — add to `.gitignore`. Rebuilt from the lockfile on install. |
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
git diff --exit-code misses new untracked files (the most common drift case when adding dependencies). git status --porcelain catches both modified and untracked files. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
danielmeppiel
added a commit
that referenced
this pull request
Mar 13, 2026
- Fix Codex runtime download 404: Windows assets use .exe.tar.gz naming - Configure UTF-8 encoding on Windows consoles to prevent UnicodeEncodeError - Resolve .cmd/.ps1 shell wrappers via shutil.which() on Windows - Replace GIT_CONFIG_GLOBAL=NUL with empty temp file for git compatibility - Update CHANGELOG v0.7.9 with Windows fixes, PR #289, PR #290 Closes #285 Co-authored-by: Sergio Sisternes <207026618+sergio-sisternes-epam@users.noreply.github.com> Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
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
Addresses #288 — the docs were silent on whether files APM deploys to
.github/should be committed or gitignored.Stance: commit them. Rationale in the issue reply.
Changes
Quick-start guide (
getting-started/quick-start.md).github/and.claude/deployed filesCI/CD guide (
integrations/ci-cd.md)git diffdrift check workflow step.github/and.claude/filesNo code changes
The current behavior (not gitignoring
.github/) is already correct. This is a docs-only clarification.Closes #288