airshipctl/tools/git_diff_check
Sirisha Gopigiri 9e8446339c Zuul gate to check if the cli doc is generated
The below code adds check zuul gate to verify
that for every cli added to airshipctl appropriate
documentation is generated.

Closes: #280
Change-Id: Iba0f4393b9785190536aae2a13109ddb75fd0ef8
2021-07-06 04:59:01 +00:00

49 lines
1.5 KiB
Bash
Executable File

#!/bin/bash
# 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.
# Update git index
git update-index -q --ignore-submodules --refresh
# Evaluate git files for difference, if found print message and fail.
git diff-files --quiet --ignore-submodules **/*.golden
if [ $? -ne 0 ]
then
echo "git diff found modified test cases, please run make update-golden"
exit 1
fi
git diff-files --quiet --ignore-submodules **/*.rst
if [ $? -ne 0 ]
then
echo "git diff found modified cli help, please run make cli-docs"
exit 1
fi
# Evaluate git index for differences, if found print message and fail.
git diff-index --cached --quiet --ignore-submodules HEAD -- **/*.golden
if [ $? -ne 0 ]
then
echo "git diff found modified test cases, please run make update-golden"
exit 1
fi
git diff-index --cached --quiet --ignore-submodules HEAD -- **/*.rst
if [ $? -ne 0 ]
then
echo "git diff found modified cli help, please run make cli-docs"
exit 1
fi
echo "no git diff detected, make target completed successfully"