You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: devel/release.md
+60-9Lines changed: 60 additions & 9 deletions
Original file line number
Diff line number
Diff line change
@@ -15,11 +15,64 @@ report issues. Typically, there is a single alpha or beta release, but if there
15
15
are a higher than expected number of issues there can be multiple releases
16
16
(e.g, a2 or b2).
17
17
18
-
## 1. Update submodules
18
+
## Automated release
19
+
20
+
### 1. (Optional) Update submodules
21
+
22
+
Update submodules by referring to this [link](https://github.com/kubernetes-client/python/blob/master/devel/submodules.md#update-submodule). Commit the changes and open a pull request.
23
+
24
+
### 2. Run the release script and send a PR
25
+
Generate a Github personal access token following instruction
Checkout the generated local branch (named "automated-release-of-xxx") to
50
+
continue with the remaining steps.
51
+
52
+
### 3. README (not required for snapshots)
53
+
54
+
Update the compatibility matrix and maintenance status in the README file.
55
+
56
+
### 4. Submit pull request
57
+
58
+
For snapshots, create a PR against the master repo.
59
+
60
+
For actual releases, create:
61
+
- a PR against the release branch
62
+
- a second PR against the master branch to cherrypick the CHANGELOG and README
63
+
changes.
64
+
65
+
### 5. (Repo admin) Create release branch
66
+
67
+
After merging a new snapshot, create a release branch from the master branch.
68
+
69
+
## (Deprecated) Manual release
70
+
71
+
### 1. Update submodules
19
72
20
73
Update submodules by referring to this [link](https://github.com/kubernetes-client/python/blob/master/devel/submodules.md#update-submodule). Commit the changes and open a pull request.
21
74
22
-
## 2. Create or update release branch
75
+
###2. Create or update release branch
23
76
24
77
The release branch name should have release-x.x format. All minor and pre-releases
25
78
should be on the same branch. To update an existing branch with master (only for
You may need to fix some conflicts. For auto-generated files, you can commit
37
10000
90
either version. They will be updated to the current version in the next step.
38
91
39
-
## 3. Update release tags
92
+
###3. Update release tags
40
93
41
94
Release tags are in the "scripts/constants.py" file. These are the constants you
42
95
may need to update:
@@ -73,7 +126,7 @@ apply the manual fixes.***
73
126
git push upstream $RELEASE_BRANCH
74
127
```
75
128
76
-
## 4. Hot issues
129
+
###4. Hot issues
77
130
78
131
Use the `scripts/apply-hotfixes.sh` script to apply the fixes below in one step.
79
132
**As mentioned above, the script should be run after finishing the section "Update release tags". Also, ensure a clean working directory before applying the script.**
@@ -99,19 +152,19 @@ For more details, see [#974](https://github.com/kubernetes-client/python/issues/
99
152
100
153
5. Add tests for the default `Configuration` behavior (ref: https://github.com/kubernetes-client/python/pull/1303 and https://github.com/kubernetes-client/python/pull/1285). The commit [1ffa61d0650e4c93e0d7f0becd2c54797eafd407](https://github.com/kubernetes-client/python/pull/1285/commits/1ffa61d0650e4c93e0d7f0becd2c54797eafd407) should be cherry-picked.
101
154
102
-
## 5. CHANGELOG
155
+
###5. CHANGELOG
103
156
104
157
Make sure the change logs are up to date [here](https://github.com/kubernetes-client/python/blob/master/CHANGELOG.md).
105
158
If they are not, follow commits added after the last release and update/commit
106
159
the change logs to master.
107
160
108
161
Then based on the release, follow one of next two steps.
109
162
110
-
## 6. README
163
+
###6. README
111
164
112
165
Update the compatibility matrix and maintenance status in the README file.
113
166
114
-
## Submit pull request
167
+
###Submit pull request
115
168
116
169
Typically after the you've completed steps 2-6 above you can push your changes
117
170
open a pull request against `kubernetes-client:release-x.y`
@@ -220,6 +273,4 @@ deactivate
220
273
rm -rf .release
221
274
```
222
275
223
-
TODO: Convert steps in this document to an (semi-) automated script.
Copy file name to clipboardExpand all lines: scripts/apply-hotfixes.sh
+14Lines changed: 14 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -64,4 +64,18 @@ else
64
64
exit 1
65
65
fi;
66
66
67
+
# Patching commit for no_proxy support
68
+
# UPDATE: The commit being cherry-picked is updated kubernetes/client/ unless OpenAPI generator v5.3.1 involved (offinical support of no_proxy feature).
69
+
# Ref: https://github.com/kubernetes-client/python/pull/1579/commits/95a893cd1c34de11a4e3893dd1dfde4a0ca30bdc and conversations in the PR.
0 commit comments