Merge pull request #14 from capralifecycle/improve-dev-scripts

Improve dev scripts

.gitignore

@@ -5,3 +5,4 @@ node_modules/
 
 .vscode/settings.json
 .idea
+.venv

Makefile

@@ -0,0 +1,18 @@
+VENV = .venv/bin
+SCRIPTS = ./dev-scripts
+
+.PHONY: all check venv update-docs
+
+all: check
+
+check:
+	npm install
+	$(SCRIPTS)/check-docs.sh
+	$(SCRIPTS)/lint-modified-shell-scripts.sh
+
+venv:
+	python -m venv .venv; \
+	$(VENV)/pip install -r requirements.txt
+
+update-docs:
+	$(SCRIPTS)/update-docs.sh

dev-scripts/update-docs.sh

@@ -0,0 +1,22 @@
+#!/usr/bin/env bash
+set -euo pipefail
+
+script_dir="$(dirname "${BASH_SOURCE[0]}")"
+cd "$script_dir/.." || exit
+
+PYTHON=".venv/bin/python"
+
+if ! command -v $PYTHON &> /dev/null; then
+  echo "Python virtual environment not found. See Makefile for setup instructions."
+  exit 1
+fi
+
+updated_readme=$($PYTHON generate-docs.py README.md)
+
+if [ "$updated_readme" = "" ]; then
+  echo "Updated README is empty, will not overwrite."
+  exit 1
+fi
+
+echo "$updated_readme" > README.md
+git diff README.md

requirements.txt

@@ -0,0 +1 @@
+PyYAML==6.0.1