Skip to content

remove repetitive examples, add docs and good examples #100

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.

Sign up for GitHub

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
sourcehawk merged 3 commits into from
Apr 1, 2026
Merged

remove repetitive examples, add docs and good examples #100

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
cbce674
remove repetitive examples, add docs and good examples
sourcehawk Apr 1, 2026
624c1b5
add utility, fix docs
sourcehawk Apr 1, 2026
0f60485
address pr comments
sourcehawk Apr 1, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 10 additions & 23 deletions Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
.PHONY: all
all: fmt lint test build-examples
all: fmt lint test test-examples build-examples

##@ General

Expand Down Expand Up @@ -121,30 +121,17 @@ test: setup-envtest
build-examples: ## Build all example binaries.
go build ./examples/...

.PHONY: test-examples
test-examples: ## Run example tests (golden files, mutation unit tests).
go test ./examples/...

.PHONY: run-examples
run-examples: ## Run all examples to verify they execute without error.
go run ./examples/deployment-primitive/.
go run ./examples/configmap-primitive/.
go run ./examples/serviceaccount-primitive/.
go run ./examples/secret-primitive/.
go run ./examples/statefulset-primitive/.
go run ./examples/replicaset-primitive/.
go run ./examples/rolebinding-primitive/.
go run ./examples/custom-resource-implementation/.
go run ./examples/service-primitive/.
go run ./examples/role-primitive/.
go run ./examples/pdb-primitive/.
go run ./examples/daemonset-primitive/.
go run ./examples/hpa-primitive/.
go run ./examples/clusterrolebinding-primitive/.
go run ./examples/clusterrole-primitive/.
go run ./examples/cronjob-primitive/.
go run ./examples/ingress-primitive/.
go run ./examples/job-primitive/.
go run ./examples/networkpolicy-primitive/.
go run ./examples/pod-primitive/.
go run ./examples/pvc-primitive/.
go run ./examples/pv-primitive/.
go run ./examples/mutations-and-gating/.
go run ./examples/extraction-and-guards/.
go run ./examples/component-prerequisites/.
go run ./examples/custom-resource/.
go run ./examples/grace-inconsistency/.
Comment on lines 128 to +134
Copy link

Copilot AI Apr 1, 2026

Choose a reason for hiding this comment

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

make test (used by CI) excludes ./examples/..., but this PR adds multiple *_test.go golden tests under examples/. As-is, those tests won't run in CI and can silently drift. Consider adding a dedicated test-examples target (e.g., go test ./examples/...) and wiring it into all/CI, or at minimum run go test ./examples/... as part of run-examples so these golden tests execute regularly.

Copilot uses AI. Check for mistakes.

##@ E2E Testing

Expand Down
215 changes: 206 additions & 9 deletions docs/guidelines.md
View file
Open in desktop

Large diffs are not rendered by default.

2 changes: 2 additions & 0 deletions docs/primitives.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -150,6 +150,8 @@ Selectors determine which containers an editor targets. This is important for mu
selectors.AllContainers() // every container in the pod
selectors.ContainerNamed("app") // a single container by name
selectors.ContainersNamed("web", "api") // multiple containers by name
selectors.ContainerNotNamed("sidecar") // all containers except one
selectors.ContainersNotNamed("agent", "log") // all containers except several
selectors.ContainerAtIndex(0) // container at a specific index
```

Expand Down
32 changes: 0 additions & 32 deletions examples/clusterrole-primitive/README.md
View file
Open in desktop

This file was deleted.

54 changes: 0 additions & 54 deletions examples/clusterrole-primitive/app/controller.go
View file
Open in desktop

This file was deleted.

74 changes: 0 additions & 74 deletions examples/clusterrole-primitive/features/mutations.go
View file
Open in desktop

This file was deleted.

122 changes: 0 additions & 122 deletions examples/clusterrole-primitive/main.go
View file
Open in desktop

This file was deleted.

52 changes: 0 additions & 52 deletions examples/clusterrole-primitive/resources/clusterrole.go
View file
Open in desktop

This file was deleted.

Loading
Loading