Skip to content

docs(controller): add patch identity preservation guide#234

Merged
weicao merged 2 commits into
mainfrom
docs/controller-patch-identity-preservation
May 19, 2026
Merged

docs(controller): add patch identity preservation guide#234
weicao merged 2 commits into
mainfrom
docs/controller-patch-identity-preservation

Conversation

@weicao
Copy link
Copy Markdown
Contributor

@weicao weicao commented May 19, 2026

Summary

  • Add docs/controller/addon-controller-patch-identity-preservation-guide.md.
  • Define how controller PR authors should preserve a production commit SHA after addon teams have built a patch image from it.
  • Add the guide to docs/controller/README.md.

Why

When an addon team has already built and verified a patch image from a controller PR head SHA, that SHA is an evidence anchor. If reviewer feedback is test-only, doc-only, or otherwise does not change production behavior, a follow-up commit keeps that anchor valid. If production behavior must change, the addon verification owner must be told to re-check patch identity against the new SHA.

Test plan

  • addon-docs-writing self-check: problem-first opening, plain-language section, concrete case appendix, concise length.
  • git diff --check origin/main...HEAD
  • Related markdown links resolve in the changed guide.
  • PR body, commit messages, and changed docs public-hygiene grep clean.

@weicao weicao force-pushed the docs/controller-patch-identity-preservation branch from 4b9fc67 to 583b82c Compare May 19, 2026 05:31
@weicao weicao merged commit 96a6bbc into main May 19, 2026
@weicao weicao deleted the docs/controller-patch-identity-preservation branch May 19, 2026 05:32
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.

1 participant