From 5ed5a5fe2593fc172c15d0ac765cf97eb261ae4f Mon Sep 17 00:00:00 2001 From: Benjamin Elder Date: Sun, 28 Feb 2021 13:01:07 -0800 Subject: [PATCH] add test/conformance/gen-conformance-docs.sh --- test/conformance/gen-conformance-docs.sh | 28 ++++++++++++++++++++++++ test/conformance/spec-to-docs.sh | 26 ++++++++++++++++++++++ 2 files changed, 54 insertions(+) create mode 100755 test/conformance/gen-conformance-docs.sh create mode 100755 test/conformance/spec-to-docs.sh diff --git a/test/conformance/gen-conformance-docs.sh b/test/conformance/gen-conformance-docs.sh new file mode 100755 index 00000000000..62d13ecbf11 --- /dev/null +++ b/test/conformance/gen-conformance-docs.sh @@ -0,0 +1,28 @@ +#!/usr/bin/env 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. + +set -o errexit +set -o nounset +set -o pipefail + +# This will canonicalize the path +KUBE_ROOT=$(cd "$(dirname "${BASH_SOURCE[0]}")"/../.. && pwd -P) +cd "${KUBE_ROOT}" + +# test sources -> json spec _output/specsummaries.json +test/conformance/gen-specsummaries.sh +# specsummaries.json -> conformance.md +test/conformance/spec-to-docs.sh diff --git a/test/conformance/spec-to-docs.sh b/test/conformance/spec-to-docs.sh new file mode 100755 index 00000000000..c6fefe8918a --- /dev/null +++ b/test/conformance/spec-to-docs.sh @@ -0,0 +1,26 @@ +#!/usr/bin/env 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. + +set -o errexit +set -o nounset +set -o pipefail + +# This will canonicalize the path +KUBE_ROOT=$(cd "$(dirname "${BASH_SOURCE[0]}")"/../.. && pwd -P) +cd "${KUBE_ROOT}" + +# convert dumped spec (see dump-spec.sh) to conformance.md +go run ./test/conformance/walk.go --source="${KUBE_ROOT}" --docs ./_output/specsummaries.json > ./_output/conformance.md \ No newline at end of file