Merge pull request #9 from gdgib/G2-1629-MultiSiteBuilds

G2-1629 Support for multiple site builds

Dockerfile

@@ -3,6 +3,7 @@ FROM nginx:alpine
 RUN apk add --no-cache \
 	bash \
 	git \
+	rsync \
 	mkdocs \
 	py3-pip \
 	mkdocs-material \
@@ -14,6 +15,7 @@ ENV MKDOCKER_REPOSITORY_URL github.com/g2forge/mkdocker
 ENV MKDOCKER_REPOSITORY_LOGIN ''
 ENV MKDOCKER_REPOSITORY_BRANCH main
 ENV MKDOCKER_REPOSITORY_DIRECTORY example
+ENV MKDOCKER_TEMP_DIRECTORY /mkdocker/temp
 ENV MKDOCKER_LOCAL_DIRECTORY /mkdocker/docs
 ENV MKDOCKER_VENV_DIRECTORY /mkdocker/venv
 ENV MKDOCKER_SERVE 0

README.md

@@ -38,6 +38,22 @@ mkdocker can run scripts both before and after the mkdocs build.
 Simply create `scripts/pre` and `scripts/post` files in the `MKDOCKER_REPOSITORY_DIRECTORY` directory, and mark them executable.
 One example of this is shown in this repository to created [protected pages](example/scripts/post) by modifying the nginx config.
 
+## Control File
+
+Each script takes two arguments: the path to a temp directory for use by the scripts, and the path to the control file.
+The `pre` script should create this file, and both mkdocker and the `post` script will consume it.
+If the `pre` script does not exist or does not create the file, mkdocker will.
+
+Each line of the control file represents a separate mkdocs build, though only the last build will be served when `MKDOCKER_SERVE` is set all will be built.
+Each line specifies a repository-relative or absolute path for the source, and a HTTP root relative path for the destination separated by a space (using bash quoting).
+`mkdocs` will be run once per line.
+
+The default control file is:
+
+```
+. .
+```
+
 # Development
 
 * Build -   `docker build ./ -t mkdocker:latest`

mkdocker/scripts/mkdocker.sh

@@ -1,6 +1,9 @@
 #!/bin/bash
 set -eu -o pipefail
 
+SCRIPT_TEMP="${MKDOCKER_TEMP_DIRECTORY}/script-temp"
+mkdir -pv "${SCRIPT_TEMP}"
+
 if [ ! -d "${MKDOCKER_LOCAL_DIRECTORY}" ]; then
 	mkdir -pv "${MKDOCKER_LOCAL_DIRECTORY}"
 	cd "${MKDOCKER_LOCAL_DIRECTORY}"
@@ -40,13 +43,32 @@ fi
 echo "Running build"
 if [ -x scripts/pre ]; then
 	echo Running pre script
-	./scripts/pre
+	./scripts/pre "${SCRIPT_TEMP}" "${MKDOCKER_TEMP_DIRECTORY}/control"
+fi
+
+if [ ! -f "${MKDOCKER_TEMP_DIRECTORY}/control" ]; then
+	cat << EOF > "${MKDOCKER_TEMP_DIRECTORY}/control"
+. .
+EOF
 fi
+# For all but the last site, build them
+while read -r SOURCE TARGET; do
+	echo "Building ${SOURCE} to ${TARGET}"
+	pushd "${SOURCE}"
+	mkdocs build -d "/usr/share/nginx/html/${TARGET}"
+	popd
+done < <(head -n -1 "${MKDOCKER_TEMP_DIRECTORY}/control")
+
+# For the last site, build or serve it
+read -r SOURCE TARGET < <(tail -n 1 "${MKDOCKER_TEMP_DIRECTORY}/control")
 if [ "${MKDOCKER_SERVE}" = 0 ]; then
-	mkdocs build -d /usr/share/nginx/html
+	echo "Building ${SOURCE} to ${TARGET}"
+	pushd "${SOURCE}"
+	mkdocs build -d "/usr/share/nginx/html/${TARGET}"
+	popd
 	if [ -x scripts/post ]; then
 		echo Running post script
-		./scripts/post
+		./scripts/post "${SCRIPT_TEMP}" "${MKDOCKER_TEMP_DIRECTORY}/control"
 	fi
 
 	if [ -d "${MKDOCKER_VENV_DIRECTORY}" ]; then
@@ -56,5 +78,8 @@ if [ "${MKDOCKER_SERVE}" = 0 ]; then
 
 	nginx -g "daemon off;"
 else
+	echo "Serving ${SOURCE}"
+	pushd "${SOURCE}"
 	mkdocs serve -a "0.0.0.0:80"
+	popd
 fi