Publish docs pr 2.x

.github/workflows/ce-provision-publish-docs.yml

@@ -25,6 +25,28 @@ jobs:
         - ${{ github.workspace }}:/home/controller
 
     steps:
+      - uses: actions/checkout@v4
+        with:
+          ref: ${{ github.event.pull_request.base.ref }}
+
+      # First build and publish the markdown docs
+      - name: Build the table of contents
+        run: /bin/sh contribute/toc.sh
+
+      # Configures global Git variables for committing
+      - name: Configure Git
+        run: |
+          /usr/bin/git config --global user.email "sysadm@codeenigma.com"
+          /usr/bin/git config --global user.name "Code Enigma CI"
+          /usr/bin/git config --global pull.rebase false
+
+      - name: Commit new table of contents back to the repo
+        run: |
+          /usr/bin/git add docs/.
+          /usr/bin/git commit -m "GitHub Actions - updating markdown docs - ${{ steps.date.outputs.date }}"
+          /usr/bin/git push
+
+      # Now build and publish the version of the docs
       - name: Install wiki2pages
         run: /usr/bin/su - ce-dev -c "/usr/bin/git clone https://github.com/codeenigma/wikis2pages.git /home/ce-dev/build/wiki2pages"
 
@@ -56,6 +78,7 @@ jobs:
           /usr/bin/su - ce-dev -c "cd /home/ce-dev/build/wiki2pages && /home/ce-dev/ansible/bin/ansible-playbook -e 'wiki2pages_build_path=/home/ce-dev/build/wiki2pages' -i /home/ce-dev/ansible/bin/hosts /home/ce-dev/build/wiki2pages/ce-dev/ansible/provision.yml"
           /usr/bin/su - ce-dev -c "cd /home/ce-dev/build/wiki2pages && /bin/sh set-current.sh --project ce-provision-${{ github.event.pull_request.base.ref }} --no-ce-dev"
           /usr/bin/su - ce-dev -c "cd /home/ce-dev/build/wiki2pages && /home/ce-dev/ansible/bin/ansible-playbook -e 'wiki2pages_build_path=/home/ce-dev/build/wiki2pages launch_hugo_server=false' -i /home/ce-dev/ansible/bin/hosts /home/ce-dev/build/wiki2pages/ce-dev/ansible/deploy.yml"
+          /usr/bin/su - ce-dev -c "cd /home/ce-dev/build/wiki2pages/content/ce-provision-${{ github.event.pull_request.base.ref }} && /bin/sh contribute/toc_hugo.sh"
 
       - name: Run Hugo
         run: |

contribute/toc.sh

@@ -114,7 +114,7 @@ parse_roles_toc(){
       "# "*)
         if [ "$WRITE" = "true" ]; then
           TITLE=$(echo "$LINE" | cut -c 3-)
-          echo "$INDENT"" - [$TITLE]($RELATIVE)" >> "$TMP_SIDEBAR"
+          echo "$INDENT"" - [$TITLE](/$RELATIVE)" >> "$TMP_SIDEBAR"
           WRITE="false"
         fi
       ;;

contribute/toc_hugo.sh

@@ -0,0 +1,140 @@
+#!/bin/sh
+# shellcheck disable=SC2094
+# shellcheck disable=SC2129
+IFS=$(printf '\n\t')
+set -e
+OWN_DIR=$(dirname "$0")
+cd "$OWN_DIR" || exit 1
+OWN_DIR=$(git rev-parse --show-toplevel)
+cd "$OWN_DIR" || exit 1
+OWN_DIR=$(pwd -P)
+
+# @param
+# $1 string filepath
+cp_role_page(){
+  RELATIVE=$(realpath --relative-to="$OWN_DIR" "$(dirname "$1")")
+  if [ ! -d "$OWN_DIR/docs/$RELATIVE" ]; then
+    mkdir -p "$OWN_DIR/docs/$RELATIVE"
+  fi
+  cp "$1" "$OWN_DIR/docs/$RELATIVE.md"
+}
+
+# @param
+# $1 string folder
+cp_single_page(){
+  if [ ! -d "$OWN_DIR/docs/$1" ]; then
+    mkdir "$OWN_DIR/docs/$1"
+  fi
+  cp "$OWN_DIR/$1/README.md" "$OWN_DIR/docs/$1.md"
+}
+
+# @param
+# $1 (string) filename
+parse_role_variables(){
+  TMP_MD=$(mktemp)
+  WRITE=1
+  # Ensure we have a trailing line.
+  echo "" >> "$1"
+  while read -r LINE; do
+    case $LINE in
+    '<!--ROLEVARS-->')
+      echo "$LINE" >> "$TMP_MD"
+      generate_role_variables "$1"
+      WRITE=0
+    ;;
+    '<!--ENDROLEVARS-->')
+      echo "$LINE" >> "$TMP_MD"
+      WRITE=1
+    ;;
+    '<!--TOC-->')
+      echo "$LINE" >> "$TMP_MD"
+      WRITE=0
+    ;;
+    '<!--ENDTOC-->')
+      echo "$LINE" >> "$TMP_MD"
+      WRITE=1
+    ;;
+    *)
+    if [ $WRITE = 1 ]; then
+      echo "$LINE" >> "$TMP_MD"
+    fi
+    ;;
+    esac
+  done < "$1"
+  printf '%s\n' "$(cat "$TMP_MD")" > "$1"
+  rm "$TMP_MD"
+}
+
+# @param
+# $1 (string) filename
+generate_role_variables(){
+  VAR_FILE="$(dirname "$1")/defaults/main.yml"
+  if [ -f "$VAR_FILE" ]; then
+    echo "## Default variables"  >> "$TMP_MD"
+    echo '```yaml' >> "$TMP_MD"
+    cat "$VAR_FILE" >> "$TMP_MD"
+    echo "" >> "$TMP_MD"
+    echo '```' >> "$TMP_MD"
+    echo "" >> "$TMP_MD"
+  fi
+}
+
+generate_roles_toc(){
+  TMP_SIDEBAR=$(mktemp)
+  WRITE="true"
+  while read -r LINE; do
+    case $LINE in
+    "  - [Roles](roles)")
+      echo "$LINE" >> "$TMP_SIDEBAR"
+      parse_roles_toc roles 2
+      WRITE="false"
+    ;;
+    "  -"*)
+      WRITE="true"
+      echo "$LINE" >> "$TMP_SIDEBAR"
+    ;;
+    *)
+    if [ "$WRITE" = "true" ]; then
+      echo "$LINE" >> "$TMP_SIDEBAR"
+    fi
+    ;;
+    esac
+  done < "$OWN_DIR/docs/_Sidebar.md"
+  mv "$TMP_SIDEBAR" "$OWN_DIR/docs/_Sidebar.md"
+}
+
+parse_roles_toc(){
+  ROLES=$(find "$OWN_DIR/$1" -mindepth 2 -maxdepth 2 -name "README.md" | sort)
+  for ROLE in $ROLES; do
+    WRITE="true"
+    INDENT=$(printf %$(($2 * 2))s)
+    RELATIVE=$(realpath --relative-to="$OWN_DIR" "$(dirname "$ROLE")")
+    while read -r LINE; do
+      case $LINE in
+      "# "*)
+        if [ "$WRITE" = "true" ]; then
+          TITLE=$(echo "$LINE" | cut -c 3-)
+          echo "$INDENT"" - [$TITLE]($RELATIVE)" >> "$TMP_SIDEBAR"
+          WRITE="false"
+        fi
+      ;;
+      esac
+    done < "$ROLE"
+  parse_roles_toc "$RELATIVE" $(($2 + 1))
+  done
+}
+
+rm -rf "$OWN_DIR/docs/roles"
+ROLE_PAGES=$(find "$OWN_DIR/roles" -name "README.md")
+for ROLE_PAGE in $ROLE_PAGES; do
+  parse_role_variables "$ROLE_PAGE"
+done
+for ROLE_PAGE in $ROLE_PAGES; do
+  cp_role_page "$ROLE_PAGE"
+done
+generate_roles_toc
+
+
+cp_single_page install
+cp_single_page contribute
+cp_single_page scripts

install.sh

@@ -79,7 +79,6 @@ FIREWALL="true"
 AWS_SUPPORT="false"
 IS_LOCAL="false"
 SERVER_HOSTNAME=$(hostname)
-ANSIBLE_COMMAND=""
 
 # Parse options.
 parse_options "$@"
@@ -254,14 +253,8 @@ firewall_config:
       - "443"
 EOL
 
-# Tell Ansible this is a Docker container
-if [ "$IS_LOCAL" = "true" ]; then
-  ANSIBLE_COMMAND="ansible-playbook --extra-vars \"{is_local: $IS_LOCAL}\" /home/$CONTROLLER_USER/ce-provision/provision.yml"
-else
-  ANSIBLE_COMMAND="ansible-playbook /home/$CONTROLLER_USER/ce-provision/provision.yml"
-fi
 # Configure ce-provision
-/usr/bin/su - "$CONTROLLER_USER" -c "cd /home/$CONTROLLER_USER/ce-provision && /home/$CONTROLLER_USER/ce-python/bin/$ANSIBLE_COMMAND"
+/usr/bin/su - "$CONTROLLER_USER" -c "cd /home/$CONTROLLER_USER/ce-provision && /home/$CONTROLLER_USER/ce-python/bin/ansible-playbook --extra-vars \"{is_local: $IS_LOCAL}\" /home/$CONTROLLER_USER/ce-provision/provision.yml"
 /usr/bin/rm "/home/$CONTROLLER_USER/ce-provision/provision.yml"
 
 # Install firewall
@@ -281,7 +274,7 @@ if [ "$FIREWALL" = "true" ]; then
       ansible.builtin.import_role:
         name: debian/firewall_config
 EOL
-  /usr/bin/su - "$CONTROLLER_USER" -c "cd /home/$CONTROLLER_USER/ce-provision && /home/$CONTROLLER_USER/ce-python/bin/ansible-playbook /home/$CONTROLLER_USER/ce-provision/provision.yml"
+  /usr/bin/su - "$CONTROLLER_USER" -c "cd /home/$CONTROLLER_USER/ce-provision && /home/$CONTROLLER_USER/ce-python/bin/ansible-playbook --extra-vars \"{is_local: $IS_LOCAL}\" /home/$CONTROLLER_USER/ce-provision/provision.yml"
   /usr/bin/echo "-------------------------------------------------"
 else
   /usr/bin/echo "-------------------------------------------------"
@@ -399,7 +392,7 @@ EOT
 EOT
     /usr/bin/echo "-------------------------------------------------"
   fi
-  /usr/bin/su - "$CONTROLLER_USER" -c "cd /home/$CONTROLLER_USER/ce-provision && /home/$CONTROLLER_USER/ce-python/bin/ansible-playbook /home/$CONTROLLER_USER/ce-provision/provision.yml"
+  /usr/bin/su - "$CONTROLLER_USER" -c "cd /home/$CONTROLLER_USER/ce-provision && /home/$CONTROLLER_USER/ce-python/bin/ansible-playbook --extra-vars \"{is_local: $IS_LOCAL}\" /home/$CONTROLLER_USER/ce-provision/provision.yml"
   /usr/bin/echo "-------------------------------------------------"
 else
   /usr/bin/echo "GitLab not requested. Skipping."