Skip to content

docs: fix drift between docs, and scripts - #179

Merged
cychiang merged 5 commits into
crossplane:mainfrom
cychiang:docs/fix-provider-bootstrap-drift
Sep 15, 2026
Merged

cychiang merged 5 commits into
crossplane:mainfrom
cychiang:docs/fix-provider-bootstrap-drift

Conversation

@cychiang

@cychiang cychiang commented Sep 11, 2026 •

Copy link
Copy Markdown
Collaborator

Description of your changes

  • Close the gate between multiple version, and outdated docs
  • Improve helper functions for addType.sh, and prepare.sh. Fix some issues where not easy to add a type and domain we want

Fixes #

I have:

  • Read and followed Crossplane's contribution process.
  • Run make reviewable to ensure this PR is ready for review.
  • Added backport release-x.y labels to auto-backport this PR if necessary.

How has this code been tested

…cripts

- Rewrite the Developing walkthrough as ten runnable steps that build a real
  provider managing a Kubernetes ConfigMap, instead of an abstract stub
- Flag the generated stub's meta.WasDeleted early return: keeping it means
  Delete never runs and the ConfigMap is orphaned
- Fix stale links in PROVIDER_CHECKLIST.md and exempt it from
  provider.prepare's find-and-replace
- Have provider.prepare and provider.addtype print the registration edits they
  did not make, and the API group they resolved
- Make the API group domain configurable (provider.prepare domain=example.com);
  provider.addtype derives the suffix from the tree, so a type's group cannot
  disagree with the provider's own
- Alias the generated API import, which goimports requires once the apiversion
  looks like a module major-version suffix (v1, v2)
- Pin CROSSPLANE_CLI_VERSION to v2.3.4: a 1.x CLI drops spec.capabilities, so
  the package installs and reports Healthy but never reconciles anything
- Pin GOTOOLCHAIN from go.mod: golangci-lint cannot typecheck a standard
  library newer than the Go that built it, and GOTOOLCHAIN=auto only upgrades

Signed-off-by: Chuan-Yen Chiang <cychiang0823@gmail.com>
@cychiang cychiang changed the title docs: fix drift between th docs: fix drift between docs, and scripts Sep 11, 2026
@cychiang

Copy link
Copy Markdown
Collaborator Author

Hi @jbw976 @jonasz-lasut please take a look on these changes. Trying to fix some drifts between docs, and scripts.

@jonasz-lasut jonasz-lasut left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Thank you for the contribution @cychiang LGTM with a few nits

Comment thread PROVIDER_CHECKLIST.md Outdated
Comment thread PROVIDER_CHECKLIST.md Outdated
Comment thread Makefile Outdated
Comment thread hack/helpers/controller/KIND_LOWER/KIND_LOWER.go.tmpl
Signed-off-by: Chuan-Yen Chiang <cychiang0823@gmail.com>
Signed-off-by: Chuan-Yen Chiang <cychiang0823@gmail.com>
Signed-off-by: Chuan-Yen Chiang <cychiang0823@gmail.com>
version across each step

Signed-off-by: Chuan-Yen Chiang <cychiang0823@gmail.com>
@cychiang
cychiang merged commit d3efb9c into crossplane:main Sep 15, 2026
7 checks passed
@cychiang
cychiang deleted the docs/fix-provider-bootstrap-drift branch September 15, 2026 21:05
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