add a script to automate the release process #1426
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,10 +1,128 @@ | ||
| #!/bin/bash | ||
|
|
||
| # Copyright 2021 The Kubernetes Authors. | ||
| # | ||
| # Licensed under the Apache License, Version 2.0 (the "License"); | ||
| # you may not use this file except in compliance with the License. | ||
| # You may obtain a copy of the License at | ||
| # | ||
| # http://www.apache.org/licenses/LICENSE-2.0 | ||
| # | ||
| # Unless required by applicable law or agreed to in writing, software | ||
| # distributed under the License is distributed on an "AS IS" BASIS, | ||
| # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| # See the License for the specific language governing permissions and | ||
| # limitations under the License. | ||
|
|
||
| # Workflow | ||
| # 1. [master branch] update existing snapshot (include API change for a new alpha/beta/GA | ||
| # release) | ||
| # - add a new snapshot or reuse the existing snapshot, the latter means either | ||
| # API change happened in a k8s patch release, or we want to include some new | ||
| # python / python-base change in the release note | ||
| # - API change w/ release notes | ||
| # - master change w/ release notes | ||
| # - submodule change w/ release notes | ||
| # 2. [master branch] create new snapshot (include API change for a new alpha release) | ||
| # - add a new snapshot or reuse the existing snapshot, the latter means either | ||
| # API change happened in a k8s patch release, or we want to include some new | ||
| # python / python-base change in the release note | ||
| # - API change w/ release notes | ||
| # - master change w/ release notes | ||
| # - submodule change w/ release notes | ||
| # 3. [release branch] create a new release | ||
| # - pull master | ||
| # - it's possible that master has new changes after the latest snaphost, | ||
| # update CHANGELOG accordingly | ||
| # - for generated file, resolve conflict by committing the master version | ||
| # - abort if a snapshot doesn't exist | ||
| # - generate client change, abort if API change is detected | ||
| # - CHANGELOG: latest snapshot becomes the release, create a new snapshot | ||
| # section that reflect the master branch state | ||
| # - README: add the release to README | ||
| # - an extra PR to update CHANGELOG and README in master in sync with this new | ||
| # release | ||
| # | ||
| # Difference between 1&2: API change release notes | ||
| # | ||
| # TODO(roycaihw): | ||
| # - add user input validation | ||
| # - add function input validaiton (release/version strings start with 'v' or not) | ||
| # - automatically send a PR; provide useful links for review | ||
| # - master branch diff: https://github.com/kubernetes-client/python/compare/commit1..commit2 | ||
| # - python base diff: https://github.com/kubernetes-client/python-base/compare/commit1..commit2 | ||
| # - Kubernetes changelog, e.g. https://github.com/kubernetes/kubernetes/blob/master/CHANGELOG/CHANGELOG-1.18.md | ||
| # - add debug log | ||
| # - add a sentence about "changes since {last release}". In most cases our | ||
| # releases should be sequential. This script (the workflow above) is based on | ||
| # this assumption, and we should make the release note clear about that. | ||
|
Member
Author
There was a problem hiding this comment. @yliaog This (and the Workflow above) is the sequential releases I mentioned in #1425 (comment).
Contributor
There was a problem hiding this comment. ok. let me know once the PR is ready for review.
Member
Author
There was a problem hiding this comment. I generated a 19.0.0-snapshot client using this script: #1547 I think we can submit the current progress and develop on top of it. Please take a look. |
||
| # | ||
| # Usage: | ||
| # $ KUBERNETES_BRANCH=release-1.19 CLIENT_VERSION=19.0.0-snapshot DEVELOPMENT_STATUS="3 - Alpha" scripts/release.sh | ||
|
|
||
| set -o errexit | ||
| set -o nounset | ||
| set -o pipefail | ||
|
|
||
| repo_root="$(git rev-parse --show-toplevel)" | ||
| declare -r repo_root | ||
| cd "${repo_root}" | ||
|
|
||
| source scripts/util/changelog.sh | ||
| source scripts/util/kube_changelog.sh | ||
|
|
||
| old_client_version=$(python3 "scripts/constants.py" CLIENT_VERSION) | ||
| old_k8s_api_version=$(util::changelog::get_k8s_api_version "v$old_client_version") | ||
| KUBERNETES_BRANCH=${KUBERNETES_BRANCH:-$(python3 "scripts/constants.py" KUBERNETES_BRANCH)} | ||
| CLIENT_VERSION=${CLIENT_VERSION:-$(python3 "scripts/constants.py" CLIENT_VERSION)} | ||
| DEVELOPMENT_STATUS=${DEVELOPMENT_STATUS:-$(python3 "scripts/constants.py" DEVELOPMENT_STATUS)} | ||
|
|
||
| # get Kubernetes API Version | ||
| new_k8s_api_version=$(util::kube_changelog::find_latest_patch_version $KUBERNETES_BRANCH) | ||
| echo "Old Kubernetes API Version: $old_k8s_api_version" | ||
| echo "New Kubernetes API Version: $new_k8s_api_version" | ||
|
|
||
| sed -i "s/^KUBERNETES_BRANCH =.*$/KUBERNETES_BRANCH = \"$KUBERNETES_BRANCH\"/g" scripts/constants.py | ||
| sed -i "s/^CLIENT_VERSION =.*$/CLIENT_VERSION = \"$CLIENT_VERSION\"/g" scripts/constants.py | ||
| sed -i "s/^DEVELOPMENT_STATUS =.*$/DEVELOPMENT_STATUS = \"$DEVELOPMENT_STATUS\"/g" scripts/constants.py | ||
| git commit -am "update version constants for $CLIENT_VERSION release" | ||
|
|
||
| util::changelog::update_release_api_version $CLIENT_VERSION $old_client_version $new_k8s_api_version | ||
|
|
||
| # get API change release notes since $old_k8s_api_version. | ||
| # NOTE: $old_k8s_api_version may be one-minor-version behind $KUBERNETES_BRANCH, e.g. | ||
| # KUBERNETES_BRANCH=release-1.19 | ||
| # old_k8s_api_version=1.18.17 | ||
| # when we bump the minor version for the snapshot in the master branch. We | ||
| # don't need to collect release notes in release-1.18, because any API | ||
| # change in 1.18.x (x > 17) must be a cherrypick that is already included in | ||
| # release-1.19. | ||
| # TODO(roycaihw): not all Kubernetes API changes modify the OpenAPI spec. | ||
| # Download the patch and skip if the spec is not modified. Also we want to | ||
| # look at other k/k sections like "deprecation" | ||
| release_notes=$(util::kube_changelog::get_api_changelog "$KUBERNETES_BRANCH" "$old_k8s_api_version") | ||
| if [[ -n "$release_notes" ]]; then | ||
| util::changelog::write_changelog v$CLIENT_VERSION "### API Change" "$release_notes" | ||
| fi | ||
|
|
||
| git commit -am "update changelog" | ||
|
|
||
| # run client generator | ||
| scripts/update-client.sh | ||
|
|
||
| rm -r kubernetes/test/ | ||
| git add . | ||
| git commit -m "temporary generated commit" | ||
| scripts/apply-hotfixes.sh | ||
| git reset HEAD~2 | ||
| # custom object API is hosted in gen repo. Commit API change separately for | ||
| # easier review | ||
| if [[ -z "$(git diff kubernetes/client/api/custom_objects_api.py)" ]]; then | ||
| git add kubernetes/client/api/custom_objects_api.py | ||
| git commit -m "generated client change for custom_objects" | ||
| fi | ||
| git add kubernetes/docs kubernetes/client/api/ kubernetes/client/models/ kubernetes/swagger.json.unprocessed scripts/swagger.json | ||
| git commit -m "generated API change" | ||
| git add . | ||
| git commit -m "generated client change" | ||
| echo "Release finished successfully." | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,57 @@ | ||
| #!/bin/bash | ||
|
|
||
| # Copyright 2021 The Kubernetes Authors. | ||
| # | ||
| # Licensed under the Apache License, Version 2.0 (the "License"); | ||
| # you may not use this file except in compliance with the License. | ||
| # You may obtain a copy of the License at | ||
| # | ||
| # http://www.apache.org/licenses/LICENSE-2.0 | ||
| # | ||
| # Unless required by applicable law or agreed to in writing, software | ||
| # distributed under the License is distributed on an "AS IS" BASIS, | ||
| # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| # See the License for the specific language governing permissions and | ||
| # limitations under the License. | ||
|
|
||
|
|
||
| # Utilities for parsing Kubernetes changelog. | ||
|
|
||
| # find_latest_patch_version finds the latest released patch version for the | ||
| # given branch. | ||
| # We use the version to track what API surface the generated Python client | ||
| # cooresponds to, and collect all API change release notes up to that version. | ||
| # There is one tricky point: the code generator we use pulls the latest OpenAPI | ||
| # spec from the given branch. The spec may contain API changes that aren't | ||
| # documented in the Kubernetes release notes. Until the code generator pulls | ||
| # the spec from a tag instead of the branch, we can only collect the release | ||
| # notes the next time we generate the client. | ||
| function util::kube_changelog::find_latest_patch_version { | ||
| local kubernetes_branch=$1 | ||
|
|
||
| # trim "release-" prefix | ||
| local version=${kubernetes_branch:8} | ||
| local changelog="/tmp/k8s-changelog-$version.md" | ||
| curl -s -o $changelog "https://raw.githubusercontent.com/kubernetes/kubernetes/master/CHANGELOG/CHANGELOG-$version.md" | ||
| echo $(grep "v$version" $changelog | head -1 | sed 's/- \[//g' | sed 's/\].*//g') | ||
| rm -f $changelog | ||
| } | ||
|
|
||
| # get_api_changelog gets the API Change release notes in the given Kubernetes | ||
| # branch for all versions newer than the given trim version. | ||
| function util::kube_changelog::get_api_changelog { | ||
| local kubernetes_branch="$1" | ||
| local trim_version="$2" | ||
|
|
||
| # trim "release-" prefix | ||
| local version=${kubernetes_branch:8} | ||
| local changelog="/tmp/k8s-changelog-$version.md" | ||
| curl -s -o $changelog "https://raw.githubusercontent.com/kubernetes/kubernetes/master/CHANGELOG/CHANGELOG-$version.md" | ||
|
|
||
| # remove changelog for versions less than or equal to $trim_version | ||
| sed -i "/^# $trim_version$/q" $changelog | ||
| # ignore section titles and empty lines; add "kubernetes/kubernetes" to links; replace newline with liternal "\n" | ||
| release_notes=$(sed -n "/^### API Change/,/^#/{/^#/!p}" $changelog | sed -n "{/^$/!p}" | sed 's/(\[\#/(\[kubernetes\/kubernetes\#/g' | sed ':a;N;$!ba;s/\n/\\n/g') | ||
| rm -f $changelog | ||
| echo "$release_notes" | ||
| } |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.