summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMorgan Bauer <mbauer@us.ibm.com>2017-06-29 11:42:27 -0700
committerMorgan Bauer <mbauer@us.ibm.com>2017-06-29 11:42:27 -0700
commitbeed052f1afdcf836a3f1f1c160960fc172ae579 (patch)
tree3449359b729b6ff4a0cbcb42332a809b737f1e14
parente4230560a0fca53c2b96b9b76f002f5d27cee40d (diff)
more generator informatin
- openapi-gen as part of the build - some gengo flags - informer-gen
-rwxr-xr-xcontributors/devel/api_changes.md18
1 files changed, 17 insertions, 1 deletions
diff --git a/contributors/devel/api_changes.md b/contributors/devel/api_changes.md
index cc626a6d..17b41a18 100755
--- a/contributors/devel/api_changes.md
+++ b/contributors/devel/api_changes.md
@@ -476,10 +476,21 @@ Approximately:
- `client-gen`
- `lister-gen` which depends upon the output of `client-gen`.
- `informer-gen` which depends upon the output of `lister-gen` and `client-gen`.
+ - `openapi-gen`
- `codecgen` for fast json serialization with a codec.
+
Many of the generators are based on
-[`gengo`](https://github.com/kubernetes/gengo) and share common flags.
+[`gengo`](https://github.com/kubernetes/gengo) and share common
+flags. The `--verify-only` flag will check the existing files on disk
+and fail if they are not what would have been generated.
+
+The generators that create go code have a `--go-header-file` flag
+which should be a file that contains the header that should be
+included. This header is the copyright that should be present at the
+top of the generated file and should be checked with the
+[`repo-infra/verify/verify-boilerplane.sh`](https://github.com/kubernetes/repo-infra/blob/master/verify/verify-boilerplate.sh)
+script at a later stage of the build.
### Generate protobuf objects
@@ -515,6 +526,11 @@ both the unversioned base directory as well as in each specifically
versioned directory. The annotation does not have to have any specific
content, but it does have to exist.
+### Generate Informers
+
+`informer-gen` generates the very useful Informers which watch API
+resources for changes. It requires a client generated by `client-gen`.
+
### Edit json (un)marshaling code
We are auto-generating code for marshaling and unmarshaling json representation