fix: docs check should restore original file

Azure · Jan 29, 2024 · 72078e7 · 72078e7
1 parent 0e9971d
commit 72078e7
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 8 deletions.
diff --git a/avm_scripts/docs-check.sh b/avm_scripts/docs-check.sh
@@ -9,7 +9,7 @@ check_example_docs () {
 	echo "===> Comparing examples documentation in $dir"
 	if [ ! -z "$(diff -q "$dir/README.md" "$dir/README-generated.md")" ]; then
 		echo "==> examples/$dir/README.md is out of date. Run 'make pre-commit' to update the generated document and commit."
-		rm -f "$dir/README-generated.md"
+		mv -f "$dir/README-generated.md" "$dir/README.md"
 		exit 1
 	fi
 	rm -f "$dir/README-generated.md"
@@ -24,15 +24,14 @@ terraform-docs -c .terraform-docs.yml .
 echo "==> Comparing generated code to committed code..."
 if [ ! -z "$(diff -q README.md README-generated.md)" ]; then
 		echo "==> README.md is out of date. Run 'make pre-commit' to update the generated document and commit."
-		rm -f README-generated.md
+		mv -f README-generated.md README.md
 		exit 1
 fi
+rm -f README-generated.md
 
 cd examples
 subexamples=$(find ./ -maxdepth 1 -mindepth 1 -type d)
 for d in $subexamples; do
   check_example_docs $d
 done
 cd ..
-
-rm -f README-generated.md
diff --git a/avm_scripts_canary/docs-check.sh b/avm_scripts_canary/docs-check.sh
@@ -9,7 +9,7 @@ check_example_docs () {
 	echo "===> Comparing examples documentation in $dir"
 	if [ ! -z "$(diff -q "$dir/README.md" "$dir/README-generated.md")" ]; then
 		echo "==> examples/$dir/README.md is out of date. Run 'make pre-commit' to update the generated document and commit."
-		rm -f "$dir/README-generated.md"
+		mv -f "$dir/README-generated.md" "$dir/README.md"
 		exit 1
 	fi
 	rm -f "$dir/README-generated.md"
@@ -24,15 +24,14 @@ terraform-docs -c .terraform-docs.yml .
 echo "==> Comparing generated code to committed code..."
 if [ ! -z "$(diff -q README.md README-generated.md)" ]; then
 		echo "==> README.md is out of date. Run 'make pre-commit' to update the generated document and commit."
-		rm -f README-generated.md
+		mv -f README-generated.md README.md
 		exit 1
 fi
+rm -f README-generated.md
 
 cd examples
 subexamples=$(find ./ -maxdepth 1 -mindepth 1 -type d)
 for d in $subexamples; do
   check_example_docs $d
 done
 cd ..
-
-rm -f README-generated.md