-
Notifications
You must be signed in to change notification settings - Fork 0
docs(agents): add AGENTS.md with template-drift sync reference #167
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,29 @@ | ||
| # Agent Guide — netresearch/.github | ||
|
|
||
| Organization-level community health files, reusable GitHub Actions workflows, | ||
| and the canonical Go repository templates (`templates/go-app`, `templates/go-lib`) | ||
| that consumer repos are kept in sync with. | ||
|
|
||
| ## Template-drift sync | ||
|
|
||
| The `go-app` and `go-lib` templates under `templates/` are the source of truth | ||
| for each consumer repo's `.github/` tree. Drift between a consumer and its | ||
| template is detected and reconciled by dedicated tooling: | ||
|
|
||
| - **Detect:** `.github/workflows/drift-scan.yml` runs weekly (Mon 06:00 UTC) and | ||
| on `workflow_dispatch` (with an optional space-separated `repos:` input). It | ||
| auto-opens `Template drift: <repo> vs <go-app|go-lib>` issues and | ||
| auto-closes them once drift is gone — so after merging fixes, dispatch the | ||
| scan to close immediately instead of waiting for the next schedule. | ||
| - **Fix:** `scripts/sync-template.sh <go-app|go-lib> netresearch/<repo>` | ||
| SSH-clones the consumer, copies the template `.github/` tree, commits with | ||
| `-S --signoff`, pushes a `sync/...` branch, and opens a PR. Only drifting | ||
| files change. `.github/template.yaml` is created on first sync only and never | ||
| overwritten — it carries each repo's `intentional-drift:` state. | ||
| - **Scope:** templates declare only the ecosystems every consumer is guaranteed | ||
| to have. `go-lib` baselines `gomod + github-actions`; `go-app` adds `docker` | ||
| on top (every go-app repo ships a Dockerfile). Further extras — `npm`, | ||
| `devcontainers`, and `docker` for `go-lib` — are opt-in via a self-managed | ||
| `dependabot.yml` plus `intentional-drift`, because not every consumer has | ||
| those manifests and an undeclared ecosystem fails Dependabot with | ||
| `dependency_file_not_found`. | ||
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.