Skip to content

Commit f6fde90

Browse files
authored
Merge pull request #22898 from kbhawkey/kb-chg-release-param
modify k8s_release clone string
2 parents 91494d2 + 222c147 commit f6fde90

File tree

2 files changed

+12
-7
lines changed

2 files changed

+12
-7
lines changed

update-imported-docs/reference.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,10 @@ repos:
77
generate-command: |
88
cd $GOPATH
99
# set the branch, ex: v1.17.0 while K8S_RELEASE=1.17
10-
# CAUTION: The script won't work if you set K8S_RELEASE=1.18 before 1.18 is formally released.
11-
# The `v${K8S_RELEASE}.0` string must be a valid tag name from the kubernetes repo, which
10+
# CAUTION: The script won't work if you set K8S_RELEASE=1.18.0 before 1.18 is formally released.
11+
# The `v${K8S_RELEASE}` string must be a valid tag name from the kubernetes repo, which
1212
# is only created after the formal release.
13-
git clone --depth=1 --single-branch --branch v${K8S_RELEASE}.0 https://github.com/kubernetes/kubernetes.git src/k8s.io/kubernetes
13+
git clone --depth=1 --single-branch --branch v${K8S_RELEASE} https://github.com/kubernetes/kubernetes.git src/k8s.io/kubernetes
1414
cd src/k8s.io/kubernetes
1515
make generated_files
1616
cp -L -R vendor $GOPATH/src
@@ -24,7 +24,7 @@ repos:
2424
cd $GOPATH
2525
go get -v github.com/kubernetes-sigs/reference-docs/gen-kubectldocs
2626
cd src/github.com/kubernetes-sigs/reference-docs/
27-
# create versioned dirs if needed and fetch v${K8S_RELEASE}.0:swagger.json
27+
# create versioned dirs if needed and fetch v${K8S_RELEASE}:swagger.json
2828
make updateapispec
2929
# generate kubectl cmd reference
3030
make copycli

update-imported-docs/update-imported-docs.py

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
#!/usr/bin/env python3
22
##
3-
# This script was tested with Python 3.7.4, Go 1.13+, and PyYAML 5.1.2
3+
# This script was tested with Python 3.7.4, Go 1.14.4+, and PyYAML 5.1.2
44
# installed in a virtual environment.
55
# This script assumes you have the Python package manager 'pip' installed.
66
#
@@ -22,7 +22,7 @@
2222
# Config files:
2323
# reference.yml use this to update the reference docs
2424
# release.yml use this to auto-generate/import release notes
25-
# K8S_RELEASE: provide the release version such as, 1.17
25+
# K8S_RELEASE: provide a valid release tag such as, 1.17.0
2626
##
2727

2828
import argparse
@@ -167,7 +167,7 @@ def parse_input_args():
167167
help="reference.yml to generate reference docs; "
168168
"release.yml to generate release notes")
169169
parser.add_argument('k8s_release', type=str,
170-
help="k8s release version, ex: 1.17"
170+
help="k8s release version, ex: 1.17.0"
171171
)
172172
return parser.parse_args()
173173

@@ -188,6 +188,11 @@ def main():
188188
k8s_release = in_args.k8s_release
189189
print("k8s_release is {}".format(k8s_release))
190190

191+
# if release string does not contain patch num, add zero
192+
if len(k8s_release) == 4:
193+
k8s_release = k8s_release + ".0"
194+
print("k8s_release updated to {}".format(k8s_release))
195+
191196
curr_dir = os.path.dirname(os.path.abspath(__file__))
192197
print("curr_dir {}".format(curr_dir))
193198
root_dir = os.path.realpath(os.path.join(curr_dir, '..'))

0 commit comments

Comments
 (0)