Skip to content

Commit ca0628a

Browse files
authored
Merge pull request #8155 from raywainman/vpa-release-instructions
Update VPA release instructions with correct sequencing for tags
2 parents d1d6577 + e3ca0a4 commit ca0628a

File tree

1 file changed

+25
-12
lines changed

1 file changed

+25
-12
lines changed

vertical-pod-autoscaler/RELEASE.md

Lines changed: 25 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -160,43 +160,56 @@ we've been using them since `vertical-pod-autoscaler-0.1` and tags with the
160160
other pattern start only with `vertical-pod-autoscaler/v0.9.0` so we should make
161161
sure nothing we care about will break if we do.
162162
163-
1. [ ] Update information about newest version and K8s compatibility in
164-
[the installation section of README](https://github.com/kubernetes/autoscaler/blob/master/vertical-pod-autoscaler/README.md#installation).
163+
1. [ ] Make the following changes in the release branch:
165164
166-
1. [ ] Update the yaml and sh files:
165+
```sh
166+
git switch vpa-release-1.${minor}
167+
```
168+
169+
2. [ ] Update information about newest version and K8s compatibility in
170+
[the installation section of README](https://github.com/kubernetes/autoscaler/blob/master/vertical-pod-autoscaler/docs/installation.md#compatibility).
171+
172+
3. [ ] Update the yaml and sh files:
167173
168174
```sh
169175
sed -i -s "s|[0-9]\+\.[0-9]\+\.[0-9]\+|[*vpa-version*]|g" ./deploy/*-deployment*.yaml
170176
sed -i -s "s|DEFAULT_TAG=\"[0-9]\+\.[0-9]\+\.[0-9]\+\"|DEFAULT_TAG=\"[*vpa-version*]\"|g" ./hack/*.sh
171177
```
172178
173-
1. [ ] Generate the flags files:
179+
4. [ ] Generate the flags files:
174180
175181
```sh
176182
./hack/generate-flags.sh
177183
```
178184
179-
1. [ ] Merge these changes into branch vpa-release-1.{$minor} and optionally into master if 1.{$minor} is the latest minor release
180-
(example PR: [#5460](https://github.com/kubernetes/autoscaler/pull/5460)).
185+
5. [ ] Merge these changes into branch vpa-release-1.{$minor}. Make note of the commit hash and use it in the next step.
181186
182-
1. [ ] Tag the commit with version const change
187+
See https://github.com/kubernetes/autoscaler/pull/8154 as an example.
188+
189+
6. [ ] Tag the commit corresponding to the changes from above in the release branch.
183190
184191
```sh
192+
git checkout <commit hash>
185193
git tag -a vertical-pod-autoscaler-[*vpa-version*] -m "Vertical Pod Autoscaler release [*vpa-version*]"
186194
git tag -a vertical-pod-autoscaler/v[*vpa-version*] -m "Vertical Pod Autoscaler release [*vpa-version*]"
187195
```
188196
189-
1. [ ] Push tag
197+
7. [ ] Push tag
190198
191199
```sh
192200
git push git@github.com:kubernetes/autoscaler.git vertical-pod-autoscaler-[*vpa-version*]
193201
git push git@github.com:kubernetes/autoscaler.git vertical-pod-autoscaler/v[*vpa-version*]
194202
```
195203
196-
1. [ ] To create and publish a github release from pushed tag go to
204+
8. [ ] Create and publish a github release from pushed tag go to
197205
https://github.com/kubernetes/autoscaler/releases/tag/vertical-pod-autoscaler-[*vpa-version*],
198-
press `Create release from tag`, complete release title and release notes, tick the
199-
`This is a pre-release` box and press `Publish release`.
206+
press `Create release from tag`, complete release title and release notes and press `Publish release`.
207+
208+
9. Repeat steps 2-5 above in the **main branch**.
209+
210+
After submitting, users who use `vpa-up.sh` will now start using the latest version.
211+
212+
IMPORTANT: Make sure the tags created above exist before merging into the main branch!
200213
201214
## Permissions
202215
@@ -220,4 +233,4 @@ sure nothing we care about will break if we do.
220233
221234
A member of the
222235
[autoscaler-admins](https://github.com/orgs/kubernetes/teams/autoscaler-admins)
223-
can add you to add you as a collaborator.
236+
can add you to add you as a collaborator.

0 commit comments

Comments
 (0)