Skip to content

Commit da69bff

Browse files
committed
Document hot issues in release process
1 parent 0976d59 commit da69bff

File tree

1 file changed

+16
-3
lines changed

1 file changed

+16
-3
lines changed

devel/release.md

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -85,9 +85,22 @@ scripts/update-client.sh
8585
and commit changes (should be only version number changes) to the release branch.
8686
Name the commit something like "Update version constants for XXX release".
8787

88-
```bash
89-
git push upstream $RELEASE_BRANCH
90-
```
88+
## Hot issues
89+
90+
There are some hot issues with the client generation that require manual fixes.
91+
92+
1. Restore custom object patch hehavior. You should apply [this commit](https://github.com/kubernetes-client/python/pull/995/commits/9959273625b999ae9a8f0679c4def2ee7d699ede)
93+
to ensure custom object patch behavior is backwards compatible. For more
94+
details, see [#866](https://github.com/kubernetes-client/python/issues/866) and
95+
[#959](https://github.com/kubernetes-client/python/pull/959).
96+
97+
2. Add alias package kubernetes.client.apis with deprecation warning. You need
98+
to add [this file](https://github.com/kubernetes-client/python/blob/0976d59d6ff206f2f428cabc7a6b7b1144843b2a/kubernetes/client/apis/__init__.py)
99+
under `kubernetes/client/apis/` to ensure the package is backwards compatible.
100+
For more details, see [#974](https://github.com/kubernetes-client/python/issues/974)
101+
102+
Commit the manual changes like this [PR](https://github.com/kubernetes-client/python/pull/995/commits) does,
103+
then create your PR for review.
91104

92105
## Make distribution packages
93106

0 commit comments

Comments
 (0)