Adding AGENTS.md#4573
Conversation
Signed-off-by: Gergely Csatari <gergely.csatari@nokia.com> Assisted-by: GitHub Copilot: Claude Haiku 4.5
✅ Deploy Preview for kptdocs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
There was a problem hiding this comment.
Pull request overview
Adds a new AGENTS.md guide intended for AI/code agents working on the kpt repository, including repository context, contributor guidelines, and commonly used build/test/CI commands to reduce setup friction and encourage consistent workflows.
Changes:
- Introduces
AGENTS.mdwith generic rules for AI-assisted coding and PR reviews. - Documents key build/test targets (
make all,make test-docker, e2e targets) and environment variables. - Summarizes repository structure and CI workflows to help agents navigate the codebase.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Signed-off-by: Gergely Csatari <gergely.csatari@nokia.com> Assisted-by: GitHub Copilot: Claude Haiku 4.5 Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Signed-off-by: Gergely Csatari <gergely.csatari@nokia.com> Assisted-by: GitHub Copilot: Claude Haiku 4.5 Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Signed-off-by: Gergely Csatari <gergely.csatari@nokia.com> Assisted-by: GitHub Copilot: Claude Haiku 4.5
Signed-off-by: Gergely Csatari <gergely.csatari@nokia.com> Assisted-by: GitHub Copilot: Claude Haiku 4.5
Signed-off-by: Gergely Csatari <gergely.csatari@nokia.com> Assisted-by: GitHub Copilot: Claude Haiku 4.5 Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Signed-off-by: Gergely Csatari <gergely.csatari@nokia.com>
Signed-off-by: Gergely Csatari <gergely.csatari@nokia.com>
Signed-off-by: Gergely Csatari <gergely.csatari@nokia.com>
| make test-live-apply | ||
| ``` | ||
|
|
||
| Requires KinD with Kubernetes 1.33.4 and 1.34.0 (specific SHAs pinned in CI). These tests use Kind internally. Timeout is 20 minutes. |
There was a problem hiding this comment.
| Requires KinD with Kubernetes 1.33.4 and 1.34.0 (specific SHAs pinned in CI). These tests use Kind internally. Timeout is 20 minutes. | |
| Requires KinD with Kubernetes 1.35.5 and 1.36.1 (specific SHAs pinned in CI). These tests use Kind internally. Timeout is 20 minutes. |
| * Executes: `make all` + `make test-docker` | ||
| * Triggered on PRs (except changes limited to ignored paths like `**.md`) and pushes (pushes exclude dependabot branches) | ||
| * **.github/workflows/e2eEnvironment.yml**: KinD-based e2e tests | ||
| * Tests Kubernetes 1.33 and 1.34 with KinD v0.30.0 |
There was a problem hiding this comment.
| * Tests Kubernetes 1.33 and 1.34 with KinD v0.30.0 | |
| * Tests Kubernetes 1.35 and 1.36 with KinD v0.32.0 |
|
|
||
| * **Copyright Headers**: All files must have Apache 2.0 license header | ||
| * Use format: // Copyright YEAR The kpt Authors (or year range if modified) | ||
| * Year should match creation year, or creation-to-modification year range |
There was a problem hiding this comment.
It would be good to point out the detailed copyright year update instruction available on porch documentation https://porch.kpt.dev/docs/12_contributing/code-contribution/#update-copyright-on-files"
|
|
||
| For e2e live tests (`make test-live-apply`): | ||
|
|
||
| * KinD v0.30.0 is auto-installed by CI workflow |
There was a problem hiding this comment.
| * KinD v0.30.0 is auto-installed by CI workflow | |
| * KinD v0.32.0 is auto-installed by CI workflow |
|
|
||
| ### Known CI Skips | ||
|
|
||
| * Windows build currently disabled (see `.github/workflows/go.yml` line 88-104, issue #3463) |
There was a problem hiding this comment.
| * Windows build currently disabled (see `.github/workflows/go.yml` line 88-104, issue #3463) | |
| * Windows build currently disabled (see `.github/workflows/go.yml`, issue #3463) |
This can be removed as this gets updated on every change in that file.
Adding AGENTS.md
The original AGENTS.md was generated by GitHub Copilot: Claude Haiku 4.5. I've made small edits here and there.