Skip to content

docs(agents): add AGENTS.md with template-drift sync reference#167

Merged
CybotTM merged 2 commits into
mainfrom
docs/agents-from-memory-cleanup
Jun 3, 2026
Merged

docs(agents): add AGENTS.md with template-drift sync reference#167
CybotTM merged 2 commits into
mainfrom
docs/agents-from-memory-cleanup

Conversation

@CybotTM
Copy link
Copy Markdown
Member

@CybotTM CybotTM commented Jun 3, 2026

Create the repo's first AGENTS.md with a brief header and a Template-drift sync section documenting the durable, repo-specific workflow:

  • drift-scan.yml (weekly Mon 06:00 UTC + workflow_dispatch with repos: input) auto-opens and auto-closes template-drift issues.
  • scripts/sync-template.sh <go-app|go-lib> netresearch/<repo> reconciles a consumer's .github/ tree (signed + DCO, opens a PR), never overwriting template.yaml.
  • Universal-core dependabot scoping (gomod + github-actions) with per-repo opt-in extras to avoid dependency_file_not_found.

Verified against the live scripts/workflows in this repo. Migrated from project memory as part of the 2026-06-03 memory cleanup.

Create AGENTS.md documenting the canonical template-drift workflow: how
drift-scan.yml detects/auto-closes drift issues, how scripts/sync-template.sh
reconciles a consumer's .github/ tree, and the universal-core dependabot
scoping that avoids dependency_file_not_found. Migrated from project memory
during the 2026-06-03 memory cleanup.

Signed-off-by: Sebastian Mendel <sebastian.mendel@netresearch.de>
Copilot AI review requested due to automatic review settings June 3, 2026 11:16
Copy link
Copy Markdown

@gemini-code-assist gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request introduces a new AGENTS.md file, which serves as an Agent Guide explaining the organization's community health files, reusable GitHub Actions workflows, and Go repository templates. Feedback suggests improving the Markdown formatting in AGENTS.md by wrapping the issue title template in backticks instead of using backslash escapes to ensure consistent rendering across different Markdown parsers.

Important

The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.

Comment thread AGENTS.md
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Adds an AGENTS.md guide for this repository describing how template drift is detected and reconciled for consumer repositories, plus how Dependabot configuration is scoped to avoid dependency_file_not_found failures.

Changes:

  • Introduces AGENTS.md with a repo-level overview of what netresearch/.github contains.
  • Documents the template-drift workflow (drift-scan.yml issue lifecycle + scripts/sync-template.sh remediation).
  • Documents Dependabot ecosystem scoping/opt-in guidance for consumers.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread AGENTS.md Outdated
Comment thread AGENTS.md Outdated
…le rendering

Address review feedback on the new AGENTS.md template-drift section:

- Scope: clarify the per-template Dependabot baseline. go-lib baselines
  gomod + github-actions; go-app adds docker (every go-app repo ships a
  Dockerfile). npm, devcontainers, and docker-for-go-lib are opt-in. The
  previous text implied docker was opt-in for both, misstating the go-app
  baseline.
- Use the full .github/template.yaml path to match sync-template.sh and
  drift-scan.yml instead of the bare template.yaml.
- Wrap the auto-opened issue title in backticks instead of backslash-escaped
  angle brackets for consistent Markdown rendering.

Signed-off-by: Sebastian Mendel <sebastian.mendel@netresearch.de>
@sonarqubecloud
Copy link
Copy Markdown

sonarqubecloud Bot commented Jun 3, 2026

@CybotTM CybotTM merged commit d5ae1bd into main Jun 3, 2026
11 checks passed
@CybotTM CybotTM deleted the docs/agents-from-memory-cleanup branch June 3, 2026 11:30
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.

2 participants