dev: added bash utility script for docker

yuri-rage · Hwurzburg · commit 1fe79b6b7432 · 2024-09-08T20:37:07.000-05:00
diff --git a/common/source/docs/common-wiki-editing-setup.rst b/common/source/docs/common-wiki-editing-setup.rst
@@ -122,6 +122,15 @@ This will build a docker image with all package setup to build the wiki and name
 
        docker run --rm -it -v "${PWD}:/ardupilot_wiki" -u "$(id -u):$(id -g)" ardupilot_wiki python3 update.py
 
+#. Alternately, use the bash utility script in the ``ardupilot_wiki`` root directory:
+
+   .. code-block:: bash
+
+       ./docker_update_py.sh  # presents a brief menu of build options
+
+       # or, to build the copter site with the --fast flag, for example:
+       ./docker_update_py.sh --fast --site copter
+
 That will build the wiki with the ``update.py`` similarly as in `Build the Wiki`_. The `-v` is used to share the content of the current directory, that holds all the documentation, to the container. The `-u` is used to make docker use the same permission as your current user. With those two commands, the resulting build is accessible as in `Check the Results`_
 
 Build the Wiki
diff --git a/docker_update_py.sh b/docker_update_py.sh
@@ -0,0 +1,52 @@
+#!/bin/bash
+# utility script to build the ardupilot_wiki with docker
+
+BOLD='\e[1m'
+RED='\e[31m'
+GREEN='\e[32m'
+YELLOW='\e[33m'
+MAGENTA='\e[35m'
+NC='\e[0m' # no color
+
+show_menu() {
+    echo -e "\n${BOLD}${YELLOW}Select ArduPilot Wiki site to build:${NC}\n"
+    echo -e "  ${MAGENTA}1) Copter${NC}"
+    echo -e "  ${MAGENTA}2) Plane${NC}"
+    echo -e "  ${MAGENTA}3) Rover${NC}"
+    echo -e "  ${MAGENTA}4) Dev${NC}"
+    echo -e "  ${MAGENTA}5) All${NC}"
+    echo -en "\nEnter choice [1-5]: "
+    read choice
+
+    case $choice in
+        1) site_option="--site copter" ;;
+        2) site_option="--site plane" ;;
+        3) site_option="--site rover" ;;
+        4) site_option="--site dev" ;;
+        5) site_option="" ;;
+        *) echo -e "\n${BOLD}${RED}Invalid choice.${NC}" && show_menu ;;
+    esac
+
+    echo -en "\nBuild fast? (Y/n): "
+    read fast_choice
+    if [[ -z "$fast_choice" || "$fast_choice" =~ ^([yY][eE][sS]|[yY])$ ]]; then
+        fast_option="--fast"
+    else
+        fast_option=""
+    fi
+
+    echo -e "\nRunning: ${BOLD}${GREEN}update.py $fast_option $site_option${NC}\n"
+    run_command $fast_option $site_option
+}
+
+run_command() {
+    docker run --rm -it -v "${PWD}:/ardupilot_wiki" -u "$(id -u):$(id -g)" ardupilot_wiki python3 update.py "$@"
+}
+
+if [ "$#" -eq 0 ]; then
+    # if no arguments given, show menu of options for building
+    show_menu
+else
+    # build with docker using arguments passed via CLI
+    run_command "$@"
+fi
