Add rule to assert that the current working directory is clean

kgryte · kgryte · commit 3a5ba514bbc5 · 2021-08-14T16:00:13.000-07:00
diff --git a/tools/make/Makefile b/tools/make/Makefile
@@ -98,6 +98,7 @@ include $(TOOLS_MAKE_LIB_DIR)/test-install/Makefile
 include $(TOOLS_MAKE_LIB_DIR)/tools-test/Makefile
 include $(TOOLS_MAKE_LIB_DIR)/tools-test-cov/Makefile
 include $(TOOLS_MAKE_LIB_DIR)/types-cov/Makefile
+include $(TOOLS_MAKE_LIB_DIR)/utils/Makefile
 include $(TOOLS_MAKE_LIB_DIR)/wasm/Makefile
 include $(TOOLS_MAKE_LIB_DIR)/workshops/Makefile
 
diff --git a/tools/make/lib/utils/Makefile b/tools/make/lib/utils/Makefile
@@ -0,0 +1,33 @@
+#/
+# @license Apache-2.0
+#
+# Copyright (c) 2021 The Stdlib 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.
+#/
+
+# RULES #
+
+#/
+# Asserts that the current working directory is clean (i.e., does not contain uncommitted changes).
+#
+# @example
+# make assert-clean-working-directory
+#/
+assert-clean-working-directory:
+	$(QUIET) if [[ -n "$(shell $(GIT) status --porcelain)" ]]; then \
+		echo ''; \
+		echo 'Error: invalid operation. Must have a clean working directory.'; \
+		echo ''; \
+		exit 1; \
+	fi
diff --git a/tools/make/lib/utils/README.md b/tools/make/lib/utils/README.md
@@ -0,0 +1,75 @@
+<!--
+
+@license Apache-2.0
+
+Copyright (c) 2021 The Stdlib 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.
+
+-->
+
+# Utilities
+
+> Utility commands for use in [`make`][make] recipes.
+
+<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->
+
+<section class="intro">
+
+This directory contains [`make`][make] rules providing various utilities for use in [`make`][make] recipes.
+
+</section>
+
+<!-- /.intro -->
+
+<!-- Usage documentation. -->
+
+<section class="usage">
+
+## Usage
+
+```text
+Usage: make <command> [<ENV_VAR>=<value> <ENV_VAR>=<value> ...]
+```
+
+### Commands
+
+#### assert-clean-working-directory
+
+Asserts that the current working directory is "clean" (i.e., does not contain any uncommitted changes)
+
+```bash
+$ make assert-clean-working-directory
+```
+
+</section>
+
+<!-- /.usage -->
+
+<!-- Section to include notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
+
+<section class="notes">
+
+</section>
+
+<!-- /.notes -->
+
+<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
+
+<section class="links">
+
+[make]: https://www.gnu.org/software/make/
+
+</section>
+
+<!-- /.links -->
