FilesExpand file tree

 master

/

verify-api-reference-docs.sh

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

executable file

·

48 lines (39 loc) · 1.46 KB

 master

/

verify-api-reference-docs.sh

Copy path

Top

File metadata and controls

• Code
• Blame

executable file

·

48 lines (39 loc) · 1.46 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

45

46

47

48

#!/bin/bash

# Copyright 2015 The Kubernetes Authors All rights reserved.

#

# 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.

# Verifies that api reference docs are upto date.

set -o errexit

set -o nounset

set -o pipefail

KUBE_ROOT=$(dirname "${BASH_SOURCE}")/..

source "${KUBE_ROOT}/hack/lib/init.sh"

kube::golang::setup_env

API_REFERENCE_DOCS_ROOT="${KUBE_ROOT}/docs/api-reference"

OUTPUT_DIR="${KUBE_ROOT}/_tmp/api-reference"

mkdir -p ${OUTPUT_DIR}

TMP_ROOT="${KUBE_ROOT}/_tmp"

# Generate API reference docs in tmp.

"./hack/update-api-reference-docs.sh" "${OUTPUT_DIR}"

echo "diffing ${API_REFERENCE_DOCS_ROOT} against freshly generated docs"

ret=0

diff -Naupr -I 'Last update' --exclude=*.md "${API_REFERENCE_DOCS_ROOT}" "${OUTPUT_DIR}" || ret=$?

rm -rf "${TMP_ROOT}"

if [[ $ret -eq 0 ]]

then

echo "${API_REFERENCE_DOCS_ROOT} up to date."

else

echo "${API_REFERENCE_DOCS_ROOT} is out of date. Please run hack/update-api-reference-docs.sh"

exit 1

fi

# ex: ts=2 sw=2 et filetype=sh