add update-submodule script #1419

roycaihw · 2021-04-20T05:33:10Z

I'm working on adding scripts to automate the release process. This one updates python-base submodule and collects the release notes.

Example output in master branch:

$ scripts/update-submodule.sh
Submodule path 'kubernetes/base': checked out 'f38221ce0039b71152963edfc3012576368bdfee'
INFO Using output format: markdown
INFO Gathering release notes
INFO Starting to process commit 1 of 11 (9.09%): f38221ce0039b71152963edfc3012576368bdfee
INFO Starting to process commit 2 of 11 (18.18%): fc5b7302b161697ed6fbdf0c5aa85a119768255a
INFO Starting to process commit 3 of 11 (27.27%): e514f69dff7dc090716a233d16b62f87fcdb5b3d
INFO Starting to process commit 4 of 11 (36.36%): 10ae4760b53a917116ae7525a7bbc94f35632cfb
INFO Starting to process commit 5 of 11 (45.45%): db50d0292eb52ac1162d9eb324662c600c5ea6e3
INFO Starting to process commit 6 of 11 (54.55%): 90399663f378b33227f723d3f0c1677965b6d96b
INFO Starting to process commit 7 of 11 (63.64%): fb425a3bec5e5597ff44e810241699ba57377046
INFO Starting to process commit 8 of 11 (72.73%): ed98daeae96c6dc4f245421497c390c009dcec72
INFO Starting to process commit 9 of 11 (81.82%): 93aa318705b93dbd39a61177bb8d4df9db0dddc4
INFO Starting to process commit 10 of 11 (90.91%): 2ea3efbc628597ed3ed2bf3c16e684727addd75b
INFO Starting to process commit 11 of 11 (100.00%): 060cac10e53169c904e0d50b7448233829019e35
INFO PR #233 seems to contain a release note
INFO PR #234 seems to contain a release note
INFO PR #231 seems to contain a release note
INFO PR #231 seems to contain a release note
INFO PR #234 seems to contain a release note
INFO PR #233 seems to contain a release note
INFO finished gathering release notes in 1.285339237s
INFO Got 3 release notes, performing rendering
INFO Release notes written to file: /tmp/python-base-relnote.md
Writing the following release notes to CHANGELOG line 5:
### Feature
- Load_kube_config_from_dict() support define custom temp files path ([kubernetes-client/python-base#233](https://github.com/kubernetes-client/python-base/pull/233), [@onecer](https://github.com/onecer))

Writing the following release notes to CHANGELOG line 5:
### Bug or Regression
- Fix watch stream non-chunked response handling ([kubernetes-client/python-base#231](https://github.com/kubernetes-client/python-base/pull/231), [@dhague](https://github.com/dhague))
- Fixed a decoding error for BOOTMARK watch events ([kubernetes-client/python-base#234](https://github.com/kubernetes-client/python-base/pull/234), [@yliaog](https://github.com/yliaog))

Successfully updated CHANGELOG for submodule.

$ git diff
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 715967add..c18dfd600 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -2,6 +2,13 @@

 Kubernetes API Version: 1.17.13

+### Bug or Regression
+- Fix watch stream non-chunked response handling ([kubernetes-client/python-base#231](https://github.com/kubernetes-client/python-base/pull/231), [@dhague](https://github.com/dhague))
+- Fixed a decoding error for BOOTMARK watch events ([kubernetes-client/python-base#234](https://github.com/kubernetes-client/python-base/pull/234), [@yliaog](https://github.com/yliaog))
+
+### Feature
+- Load_kube_config_from_dict() support define custom temp files path ([kubernetes-client/python-base#233](https://github.com/kubernetes-client/python-base/pull/233), [@onecer](https://github.com/onecer))
+
 **Important Information:**

 - The Kubernetes Python client versioning scheme has changed. The version numbers used till Kubernetes Python Client v12.y.z lagged behind the actual Kubernetes minor version numbers. From this release, the client is moving a version format `vY.Z.P` where `Y` and `Z` are respectively from the Kubernetes version `v1.Y.Z` and `P` would incremented due to changes on the Python client side itself. Ref: https://github.com/kubernetes-client/python/issues/1244
diff --git a/kubernetes/base b/kubernetes/base
index 060cac10e..f38221ce0 160000
--- a/kubernetes/base
+++ b/kubernetes/base
@@ -1 +1 @@
-Subproject commit 060cac10e53169c904e0d50b7448233829019e35
+Subproject commit f38221ce0039b71152963edfc3012576368bdfee

/cc @yliaog

k8s-ci-robot · 2021-04-20T05:33:17Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: roycaihw

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

~~OWNERS~~ [roycaihw]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

yliaog · 2021-04-20T17:25:16Z

devel/submodules.md

 ```

-Once updated, you should create a new PR to commit changes to the repository.
+Create a commit "generated python-base update" and send a PR to the main repo.


it's not obvious what is 'main' repo, better to just use 'this repository'

yliaog · 2021-04-20T17:27:57Z

scripts/update-submodule.sh

+#
+# Create a commit "generated python-base update" and send a PR to the main repo.
+# NOTE: not all python-base changes are user-facing, and you may want to remove
+# some of the non-user-facing release notes from CHANGELOG.md.


is there a release-note label in PR similar to k/k? then it's the matter of automatically collecting all those notes w/o any non user-facing notes

updated to use a release-note label. I'm going to add PR template to python-base and see if we can enable release-note-required in these repos.

yliaog · 2021-04-20T17:29:43Z

scripts/update-submodule.sh

+
+# TODO(roycaihw): make the script send a PR by default (standalone mode), and
+# have an option to make the script reusable by other release automations.
+TARGET_RELEASE=${TARGET_RELEASE:-"v$(grep "^CLIENT_VERSION = \"" scripts/constants.py | sed "s/CLIENT_VERSION = \"//g" | sed "s/\"//g")"}


so TARGET_RELEASE is an env var that can be set when running the script, better put it in the Usage: section above to make it clear.

yliaog · 2021-04-20T17:30:43Z

scripts/update-submodule.sh

+  curl -o "/tmp/${pull}.patch" -sSL "${pull_url}.patch"
+  subject=$(grep -m 1 "^Subject" "/tmp/${pull}.patch" | sed -e 's/Subject: \[PATCH//g' | sed 's/.*] //')
+  pull_uid="$submodule_repo#${pull}"
+  release_note="- ${subject} [${pull_uid}](${pull_url})\n"


again, release note is from subject here, better to have a release note section in PR

yliaog · 2021-04-20T17:33:33Z

scripts/update-submodule.sh

+echo -e $release_notes
+
+# update changelog
+sed -i "${line_to_edit}i${release_notes}" CHANGELOG.md


there are 'breaking change', 'bug fix', 'new feature' etc sections in each release note section, looks that this script does not handle that.

the script now uses https://github.com/kubernetes/release/tree/master/cmd/release-notes, which collects release notes from the PR description (will update PR template) and categories the release notes based on PR labels, e.g. kind/bug

yliaog · 2021-04-20T17:40:20Z

scripts/update-submodule.sh

+# Usage:
+#   scripts/update-submodule.sh
+#
+# Create a commit "generated python-base update" and send a PR to the main repo.


i don't see it creates a commit for Release notes, and also it does not send a PR, does it?

it doesn't. I added a TODO and made the comment clear that the user needs to manually create the commit and PR.

copied from k/k. We should add the same template to python-base

yliaog · 2021-04-21T00:31:21Z

/lgtm

yliaog · 2021-04-21T00:32:21Z

/hold
please squash the commits

roycaihw · 2021-04-21T00:41:39Z

The robot merged the PR first :(

/shrug

add update-submodule script

7b9e77b

k8s-ci-robot requested a review from yliaog April 20, 2021 05:33

k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Apr 20, 2021

k8s-ci-robot added approved Indicates a PR has been approved by an approver from all required OWNERS files. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Apr 20, 2021

yliaog reviewed Apr 20, 2021

View reviewed changes

roycaihw added 2 commits April 20, 2021 11:01

add PR template

d86a47d

copied from k/k. We should add the same template to python-base

fixup! add update-submodule script

83d294e

roycaihw mentioned this pull request Apr 21, 2021

python client repos: require kind label and release notes in pull requests kubernetes/test-infra#21880

Merged

k8s-ci-robot assigned yliaog Apr 21, 2021

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Apr 21, 2021

k8s-ci-robot merged commit 683ea36 into kubernetes-client:master Apr 21, 2021

k8s-ci-robot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Apr 21, 2021

k8s-ci-robot added the ¯\_(ツ)_/¯ ¯\\\_(ツ)_/¯ label Apr 21, 2021

roycaihw mentioned this pull request Apr 21, 2021

Bump openapi-generator version in a future pre-release #1421

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

add update-submodule script #1419

add update-submodule script #1419

roycaihw commented Apr 20, 2021 •

edited

Loading

k8s-ci-robot commented Apr 20, 2021

yliaog Apr 20, 2021

roycaihw Apr 20, 2021

yliaog Apr 20, 2021

roycaihw Apr 21, 2021

yliaog Apr 20, 2021

roycaihw Apr 21, 2021

yliaog Apr 20, 2021

roycaihw Apr 21, 2021

yliaog Apr 20, 2021

roycaihw Apr 21, 2021

yliaog Apr 20, 2021

roycaihw Apr 21, 2021

yliaog commented Apr 21, 2021

yliaog commented Apr 21, 2021

roycaihw commented Apr 21, 2021

add update-submodule script #1419

add update-submodule script #1419

Conversation

roycaihw commented Apr 20, 2021 • edited Loading

k8s-ci-robot commented Apr 20, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

yliaog commented Apr 21, 2021

yliaog commented Apr 21, 2021

roycaihw commented Apr 21, 2021

roycaihw commented Apr 20, 2021 •

edited

Loading