github/kubernetes
1
0
Fork 0
mirror of https://github.com/k3s-io/kubernetes.git synced 2025-08-03 17:30:00 +00:00
Code Issues Projects Releases Wiki Activity

Merge pull request #23424 from ddysher/update-api-changes

Browse Source 
Automatic merge from submit-queue

Update API change for internal types
This commit is contained in:
k8s-merge-robot 2016-04-19 05:16:49 -07:00
commit 7ab0a9f634
1 changed files with 6 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
docs/devel/api_changes.md
View File

@ -51,7 +51,6 @@ found at [API Conventions](api-conventions.md).
- [Edit types.go](#edit-typesgo) - [Edit types.go](#edit-typesgo)
- [Edit validation.go](#edit-validationgo) - [Edit validation.go](#edit-validationgo)
- [Edit version conversions](#edit-version-conversions) - [Edit version conversions](#edit-version-conversions)
- [Edit deep copy files](#edit-deep-copy-files)
- [Edit json (un)marshaling code](#edit-json-unmarshaling-code) - [Edit json (un)marshaling code](#edit-json-unmarshaling-code)
- [Making a new API Group](#making-a-new-api-group) - [Making a new API Group](#making-a-new-api-group)
- [Update the fuzzer](#update-the-fuzzer) - [Update the fuzzer](#update-the-fuzzer)
@ -456,9 +455,14 @@ regenerate auto-generated ones. To regenerate them:
- run - run
```sh ```sh
hack/update-generated-conversions.sh hack/update-codegen.sh
``` ```
update-codegen will also generate code to handle deep copy of your versioned
api objects. The deep copy code resides with each versioned API:
- `pkg/api/<version>/deep_copy_generated.go` containing auto-generated copy functions
- `pkg/apis/extensions/<version>/deep_copy_generated.go` containing auto-generated copy functions
If running the above script is impossible due to compile errors, the easiest If running the above script is impossible due to compile errors, the easiest
workaround is to comment out the code causing errors and let the script to workaround is to comment out the code causing errors and let the script to
regenerate it. If the auto-generated conversion methods are not used by the regenerate it. If the auto-generated conversion methods are not used by the
@ -468,23 +472,6 @@ generator to create it from scratch.
Unsurprisingly, adding manually written conversion also requires you to add tests to Unsurprisingly, adding manually written conversion also requires you to add tests to
`pkg/api/<version>/conversion_test.go`. `pkg/api/<version>/conversion_test.go`.
## Edit deep copy files
At this point you have both the versioned API changes and the internal
structure changes done. You now need to generate code to handle deep copy
of your versioned api objects.
The deep copy code resides with each versioned API:
- `pkg/api/<version>/deep_copy_generated.go` containing auto-generated copy functions
- `pkg/apis/extensions/<version>/deep_copy_generated.go` containing auto-generated copy functions
To regenerate them:
- run
```sh
hack/update-generated-deep-copies.sh
```
## Edit json (un)marshaling code ## Edit json (un)marshaling code
We are auto-generating code for marshaling and unmarshaling json representation We are auto-generating code for marshaling and unmarshaling json representation