Adding AGENTS.md by CsatariGergely · Pull Request #4573 · kptdev/kpt

CsatariGergely · 2026-06-04T11:49:27Z

Adding AGENTS.md

Usage of AI
The original AGENTS.md was generated by GitHub Copilot: Claude Haiku 4.5. I've made small edits here and there.

Signed-off-by: Gergely Csatari <gergely.csatari@nokia.com> Assisted-by: GitHub Copilot: Claude Haiku 4.5

netlify · 2026-06-04T11:49:31Z

✅ Deploy Preview for kptdocs ready!

Name	Link
🔨 Latest commit	`6f7c4f6`
🔍 Latest deploy log	https://app.netlify.com/projects/kptdocs/deploys/6a29124ef9f05c0008b9d659
😎 Deploy Preview	https://deploy-preview-4573--kptdocs.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.
🤖 Make changes	Run an agent on this branch

To edit notification comments on pull requests, go to your Netlify project configuration.

Copilot

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.md with 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>

Copilot

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated 8 comments.

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>

Copilot

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated 4 comments.

Signed-off-by: Gergely Csatari <gergely.csatari@nokia.com> Assisted-by: GitHub Copilot: Claude Haiku 4.5

Copilot

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated 2 comments.

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>

Copilot

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated 2 comments.

+* **.github/workflows/verifyContent.yml**: Verifies CLI examples
+  * Runs `make build`, installs mdrip/kind, runs `make site-verify-examples`
+  * Triggered on changes to `commands/`, `internal/` paths


+
+## Environment Variables
+
+* **KRM_FN_RUNTIME**: Select function runtime for tests: `docker`,  `podman` or `nerdctl`


mozesl-nokia · 2026-06-10T08:13:20Z

+
+**kpt** is a package-centric toolchain that automates Kubernetes configuration editing and management. It enables declarative configuration authoring, automation, and delivery at scale through a "Configuration as Data" approach, supporting Kubernetes platforms and KRM-driven infrastructure (e.g., Config Connector, Crossplane).
+
+- **Language**: Go 1.26.3


Should the version be included?

mozesl-nokia · 2026-06-10T08:13:37Z

+**kpt** is a package-centric toolchain that automates Kubernetes configuration editing and management. It enables declarative configuration authoring, automation, and delivery at scale through a "Configuration as Data" approach, supporting Kubernetes platforms and KRM-driven infrastructure (e.g., Config Connector, Crossplane).
+
+- **Language**: Go 1.26.3
+- **Repository Size**: ~78 MB


I don't think this is meaningful info like this, we could put an approx line or file count, but that would also have to be kept up to date.

mozesl-nokia · 2026-06-10T08:14:42Z

+**Trust these instructions first.** Only perform searches if you find this information incomplete or inaccurate.
+
+### Prerequisites
+- Go 1.26.3 (specified in `go.mod`)


I think we should instruct the AI to check the go.mod for this so we don't have to update it here too.

mozesl-nokia · 2026-06-10T08:15:07Z

+- Go 1.26.3 (specified in `go.mod`)
+- Git (required and checked at runtime)
+- Docker or Podman (for `test-docker` and function runtime tests)
+- KinD (CI uses v0.30.0 for live e2e/apply workflows; `make install-kind` installs v0.29.0 and is used by `verifyContent.yml`) (for e2e live apply tests with Kubernetes 1.33 and 1.34)


Again, we should point it at the file containing the version, not specify it straight up.

mozesl-nokia · 2026-06-10T08:16:12Z

+make fix        # Run go fix
+make vet        # Run go vet
+make tidy       # Run go mod tidy
+make generate   # Generate code from templates (mdtogo, copyright headers)


I think generate runs schema generation too, please check

mozesl-nokia · 2026-06-10T08:16:42Z

+* **.golangci.yml**: Linting configuration (golangci-lint v2.11.4)
+* **go.mod / go.sum**: Dependency management (Go 1.26.3)


Again, I think we should remove the versions.

mozesl-nokia · 2026-06-10T08:17:21Z

+### Build & CI Configuration
+
+* **.github/workflows/go.yml**: Main CI workflow
+  * Runs on Linux (docker/podman matrix) and macOS
+  * 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/verifyContent.yml**: Verifies CLI examples
+  * Runs `make build`, installs mdrip/kind, runs `make site-verify-examples`
+  * Triggered on changes to `commands/`, `internal/` paths
+* **.github/workflows/e2eEnvironment.yml**: KinD-based e2e tests
+  * Tests Kubernetes 1.33 and 1.34 with KinD v0.30.0
+  * Runs `./e2e/live/end-to-end-test.sh -k <K8S_VERSION>`
+* **.github/workflows/live-e2e.yml**: Live apply e2e tests
+  * Tests with pinned Kubernetes image SHAs
+  * Runs `make test-live-apply` with `K8S_VERSION` environment variable


Be sure to update this if the API module separation goes in before this PR

mozesl-nokia · 2026-06-10T08:17:47Z

+
+* **release/**: Release automation (GoReleaser config, Homebrew formula generation)
+* **hack/**: Miscellaneous development utilities
+* **healthcheck/**: Separate module for health checking (Go 1.26.3, local Makefile)


Another go version ref

mozesl-nokia · 2026-06-10T08:18:37Z

+### Linter Configuration
+
+* **Enabled Linters**: bodyclose, copyloopvar, dogsled, dupl, errcheck, gochecknoinits, goconst, gocritic, gocyclo, govet, ineffassign, lll, misspell, nakedret, revive, staticcheck, unconvert, unparam, unused, whitespace
+* **Duplication Threshold**: 400 lines
+* **Cyclomatic Complexity**: max 30
+* **Line Length**: max 170 characters
+* **Revive Confidence**: 0.85
+* **Excluded Paths**: thirdparty/, third_party, builtin, examples
+* **Test Files**: `funlen` and `gosec` are currently disabled project-wide (see `.golangci.yml`); if enabled later,
+  test files have additional exclusions configured.


Again, I think we should point it at the file so we don't have to keep this info up to date here.

Adding AGENTS.md

9248934

Signed-off-by: Gergely Csatari <gergely.csatari@nokia.com> Assisted-by: GitHub Copilot: Claude Haiku 4.5

Copilot AI review requested due to automatic review settings June 4, 2026 11:49

CsatariGergely requested review from efiacor, kispaljr, liamfallon and mozesl-nokia as code owners June 4, 2026 11:49

dosubot Bot added size:L This PR changes 100-499 lines, ignoring generated files. documentation Improvements or additions to documentation labels Jun 4, 2026

Copilot started reviewing on behalf of CsatariGergely June 4, 2026 11:49 View session

This was linked to issues Jun 4, 2026

Finetune Copilot settings #4568

Open

Add AGENTS.md to the repos of the kptdev org #4569

Open

Copilot AI reviewed Jun 4, 2026

View reviewed changes

Comment thread AGENTS.md Outdated

Comment thread AGENTS.md Outdated

Comment thread AGENTS.md Outdated

Comment thread AGENTS.md Outdated

Comment thread AGENTS.md Outdated

Comment thread AGENTS.md Outdated

Comment thread AGENTS.md

Comment thread AGENTS.md Outdated

Apply suggestions from code review

18dc440

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>

Copilot AI review requested due to automatic review settings June 4, 2026 12:58

Copilot started reviewing on behalf of CsatariGergely June 4, 2026 12:58 View session

Copilot AI reviewed Jun 4, 2026

View reviewed changes

Comment thread AGENTS.md Outdated

Comment thread AGENTS.md Outdated

Comment thread AGENTS.md Outdated

Comment thread AGENTS.md

Comment thread AGENTS.md Outdated

Comment thread AGENTS.md Outdated

Comment thread AGENTS.md Outdated

Comment thread AGENTS.md Outdated

Apply suggestions from code review

6ca0982

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>

Copilot AI review requested due to automatic review settings June 5, 2026 06:15

Copilot started reviewing on behalf of CsatariGergely June 5, 2026 06:15 View session

Copilot AI reviewed Jun 5, 2026

View reviewed changes

Comment thread AGENTS.md Outdated

Comment thread AGENTS.md Outdated

Comment thread AGENTS.md Outdated

Comment thread AGENTS.md Outdated

CsatariGergely added 2 commits June 5, 2026 09:24

Fixing make fmt target description

fdeaee6

Signed-off-by: Gergely Csatari <gergely.csatari@nokia.com> Assisted-by: GitHub Copilot: Claude Haiku 4.5

Fixes based on Copilot comments

a2f8a33

Signed-off-by: Gergely Csatari <gergely.csatari@nokia.com> Assisted-by: GitHub Copilot: Claude Haiku 4.5

Copilot AI review requested due to automatic review settings June 5, 2026 07:24

Copilot started reviewing on behalf of CsatariGergely June 5, 2026 07:24 View session

Copilot AI reviewed Jun 5, 2026

View reviewed changes

Comment thread AGENTS.md Outdated

Comment thread AGENTS.md Outdated

liamfallon approved these changes Jun 10, 2026

View reviewed changes

dosubot Bot added the lgtm label Jun 10, 2026

Apply suggestions from code review

6f7c4f6

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>

Copilot AI review requested due to automatic review settings June 10, 2026 07:29

Copilot started reviewing on behalf of CsatariGergely June 10, 2026 07:29 View session

Copilot AI reviewed Jun 10, 2026

View reviewed changes

mozesl-nokia reviewed Jun 10, 2026

View reviewed changes


		## Environment Variables

		* KRM_FN_RUNTIME: Select function runtime for tests: `docker`, `podman` or `nerdctl`


		kpt is a package-centric toolchain that automates Kubernetes configuration editing and management. It enables declarative configuration authoring, automation, and delivery at scale through a "Configuration as Data" approach, supporting Kubernetes platforms and KRM-driven infrastructure (e.g., Config Connector, Crossplane).

		- Language: Go 1.26.3

		* .golangci.yml: Linting configuration (golangci-lint v2.11.4)
		* go.mod / go.sum: Dependency management (Go 1.26.3)

Conversation

CsatariGergely commented Jun 4, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

netlify Bot commented Jun 4, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for kptdocs ready!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

CsatariGergely commented Jun 4, 2026 •

edited

Loading

netlify Bot commented Jun 4, 2026 •

edited

Loading