Skip to content

docs: remove outdated import alias workaround from README #12

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
skevetter merged 1 commit into from
Apr 18, 2026
Merged

docs: remove outdated import alias workaround from README #12

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 1 addition & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ task verify

`hack/generate.go` is a Go program that orchestrates two categories of generators:

1. **API Register Generator** — Uses `github.com/devsy-org/apiserver/pkg/generate` to scan all `+resource`-annotated types under `pkg/apis/...` and produces `zz_generated.api.register.go` files containing internal (hub) types, scheme registration, storage wiring, and registry interfaces. Includes a `GroupConverter` hook that deduplicates import aliases when multiple modules expose packages with the same trailing path segments.
1. **API Register Generator** — Uses `github.com/devsy-org/apiserver/pkg/generate` to scan all `+resource`-annotated types under `pkg/apis/...` and produces `zz_generated.api.register.go` files containing internal (hub) types, scheme registration, storage wiring, and registry interfaces.

2. **k8s.io/code-generator tools** — Standard Kubernetes code generators invoked as subprocesses:
- `deepcopy-gen` — `DeepCopyInto` / `DeepCopyObject` methods
Expand All @@ -54,9 +54,3 @@ task verify
- `lister-gen` — Listers for informer caches
- `informer-gen` — SharedInformerFactory and informers
- `openapi-gen` — OpenAPI v2 schema definitions (from `k8s.io/kube-openapi`)

### Import Alias Fix

The upstream register generator builds import aliases by joining the last two path segments of a Go package (e.g. `storage` + `v1` → `storagev1`). When two different modules expose a package with identical trailing segments — such as `github.com/devsy-org/agentapi/.../storage/v1` and `github.com/devsy-org/api/.../storage/v1` — it produces duplicate aliases.

`hack/generate.go` fixes this via a `GroupConverter` callback that runs after type parsing. It detects duplicate aliases and rewrites the secondary one to include a distinguishing prefix (e.g. `agentstoragev1`), matching the convention already used in hand-written source files.
Loading