ci: update workflow documentation

.github/workflows/documentation.yml

@@ -15,15 +15,20 @@
 #                       secrets.PYPI_API_TOKEN                                      self Pypi API token (production site) - https://pypi.org/
 #                       secrets.PYPI_API_TEST_TOKEN                                 self Pypi API token (test site) - https://test.pypi.org/
 #                       secrets.SELF_DOCKERHUB_TOKEN                                self Dockerhub token
-#                       secrets.ORG_BINARYNINJA_TOKEN                               org github personal access token (fine-grained)
+#                       secrets.CODECOV_TOKEN                                       codecov upload token for nodejs projects
-#                       secrets.ORG_BINARYNINJA_TOKEN_CL                            org github personal access token (classic)
+#                       secrets.MAXMIND_GELITE_TOKEN                                maxmind API token
-#                       secrets.ORG_BINARYNINJA_DOCKERHUB_TOKEN                     org dockerhub secret
+#                       secrets.CF_ACCOUNT_ID                                       cloudflare account id
-#                       secrets.ORG_BINARYNINJA_GITEA_TOKEN                         org gitea personal access token (classic) with package:write permission
+#                       secrets.CF_ACCOUNT_TOKEN                                    cloudflare account token
-#                       secrets.BINARYSERV_GPG_KEY_ASC                              bot gpg private key (armored) | BEGIN PGP PRIVATE KEY BLOCK
+#                       secrets.ORG_TOKEN                                           org github personal access token (fine-grained)
-#                       secrets.BINARYSERV_GPG_PASSPHRASE                           bot gpg private key passphrase
+#                       secrets.ORG_TOKEN_CL                                        org github personal access token (classic)
-#                       secrets.DISCORD_WEBHOOK_CHAN_GITHUB_TVAPP2_RELEASES         discord webhook to report release notifications from github to discord
+#                       secrets.ORG_DOCKERHUB_TOKEN                                 org dockerhub secret
-#                       secrets.DISCORD_WEBHOOK_CHAN_GITHUB_TVAPP2_WORKFLOWS        discord webhook to report workflow notifications from github to discord
+#                       secrets.ORG_GITEA_TOKEN                                     org gitea personal access token (classic) with package:write permission
-#                       secrets.DISCORD_WEBHOOK_CHAN_GITHUB_TVAPP2_UPDATES          discord webhook to report activity notifications from github to discord
+#                       secrets.BOT_GPG_KEY_ASC                                     bot gpg private key (armored) | BEGIN PGP PRIVATE KEY BLOCK
+#                       secrets.BOT_GPG_KEY_B64                                     bot gpg private key (binary) converted to base64
+#                       secrets.BOT_GPG_PASSPHRASE                                  bot gpg private key passphrase
+#                       secrets.DISCORD_WEBHOOK_CHAN_GITHUB_RELEASES                discord webhook to report release notifications from github to discord
+#                       secrets.DISCORD_WEBHOOK_CHAN_GITHUB_WORKFLOWS               discord webhook to report workflow notifications from github to discord
+#                       secrets.DISCORD_WEBHOOK_CHAN_GITHUB_UPDATES                 discord webhook to report activity notifications from github to discord
 #
 #   @local              these workflows can be tested locally through the use of `act`
 #                           https://github.com/nektos/act
@@ -35,8 +40,8 @@
 #                           act -W .github/workflows/documentation.yml -s TOKEN_CL=XXXXXXXXXX --pull=false
 # #
 
-name: "📒 Docs › Build"
+name: '📒 Docs › Build'
-run-name: "📒 Docs › Build"
+run-name: '📒 Docs › Build'
 
 # #
 #   triggers
@@ -86,26 +91,78 @@ on:
                 default:        './docs/site'
                 type:           string
 
+            # #
+            #   Discord Bot › Name
+            #
+            #   The discord bot name
+            # #
+
+            DISCORD_BOT_NAME:
+                description:    '🤖 Bot Name'
+                required:       true
+                default:        'Europa'
+                type:           string
+
+            # #
+            #   Discord Bot › Avatar
+            #
+            #   The discord bot avatar to show; let's use some weird picture
+            # #
+
+            DISCORD_BOT_AVATAR:
+                description:    '🤖 Avatar URL'
+                required:       true
+                default:        'https://i.imgur.com/UqwMom1.jpeg'
+                type:           string
+
+            # #
+            #   Discord Bot › Author Icon URL
+            #
+            #   A small picture shown to the top-right of each post
+            # #
+
+            DISCORD_BOT_EMBED_AUTHOR_ICON:
+                description:    '🤖 Embed Author Icon'
+                required:       true
+                default:        'https://avatars.githubusercontent.com/u/200161462'
+                type:           string
+
+            # #
+            #   Discord Bot › Thumbnail URL
+            #
+            #   A small picture shown to the top-right of each post
+            # #
+
+            DISCORD_BOT_EMBED_THUMBNAIL:
+                description:    '🤖 Embed Thumbnail URL'
+                required:       true
+                default:        'https://avatars.githubusercontent.com/u/200161462'
+                type:           string
+
     # #
     #   Trigger › Cron
     #
     #   update documentation every X hours
     # #
 
-    schedule:
+    # schedule:
-        - cron: "0 */12 * * *"
+    #   - cron: "0 */12 * * *"
 
 # #
 #   environment variables
 # #
 
 env:
-    WORKING_DIR:                ${{ github.event.inputs.WORKING_DIR || './docs/site' }}
+    WORKING_DIR:                      ${{ github.event.inputs.WORKING_DIR || './docs/site' }}
-    ASSIGN_USER:                Aetherinox
+    DISCORD_BOT_NAME:                 ${{ github.event.inputs.DISCORD_BOT_NAME || 'Europa' }}
-    BOT_NAME_1:                 EuropaServ
+    DISCORD_BOT_AVATAR:               ${{ github.event.inputs.DISCORD_BOT_AVATAR || 'https://i.imgur.com/UqwMom1.jpeg' }}
-    BOT_NAME_2:                 BinaryServ
+    DISCORD_BOT_EMBED_AUTHOR_ICON:    ${{ github.event.inputs.DISCORD_BOT_EMBED_AUTHOR_ICON || 'https://avatars.githubusercontent.com/u/200161462' }}
-    BOT_NAME_DEPENDABOT:        dependabot[bot]
+    DISCORD_BOT_EMBED_THUMBNAIL:      ${{ github.event.inputs.DISCORD_BOT_EMBED_THUMBNAIL || 'https://avatars.githubusercontent.com/u/200161462' }}
-    BOT_NAME_RENOVATE:          renovate[bot]
+    ASSIGN_USER:                      Aetherinox
+    BOT_NAME_1:                       EuropaServ
+    BOT_NAME_2:                       BinaryServ
+    BOT_NAME_DEPENDABOT:              dependabot[bot]
+    BOT_NAME_RENOVATE:                renovate[bot]
 
 # #
 #   jobs
@@ -115,7 +172,7 @@ jobs:
     build-docs:
       # runs-on: ubuntu-latest
         runs-on: apollo-x64
-        timeout-minutes: 20
+        timeout-minutes: 10
         permissions:
             contents: write
             pages: write
@@ -124,45 +181,139 @@ jobs:
         steps:
 
             # #
-            #   Documentation › Checkout › Arm64
+            #   Documentation › Build › Checkout
             # #
 
-            - name: >-
+            - name: '☑️ Checkout'
-                ✅ Checkout
-              id: task_docs_checkout
               uses: actions/checkout@v4
+              with:
+                  fetch-depth: 0
 
             # #
-            #   Documentation › Set Env Variables
+            #   Documentation › Build › Job Information
             # #
 
             - name: >-
-                🕛 Get Timestamp
+                  🔄 Load Job
-              id: task_docs_set_timestamp
+              uses: qoomon/actions--context@v4
-              run: |
+              id: 'context'
-                  echo "NOW=$(date +'%m-%d-%Y %H:%M:%S')" >> $GITHUB_ENV
-                  echo "NOW_SHORT=$(date +'%m-%d-%Y')" >> $GITHUB_ENV
-                  echo "NOW_LONG=$(date +'%m-%d-%Y %H:%M')" >> $GITHUB_ENV
-                  echo "NOW_DOCKER_LABEL=$(date +'%Y%m%d')" >> $GITHUB_ENV
 
             # #
-            #   Documentation › Setup Python
+            #   Documentation › Build › Start
+            # #
+
+            - name: >-
+                  ✅ Start
+              run: |
+                  echo "‎"
+                  echo "―――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――"
+                  echo " Starting Job ${{ steps.context.outputs.job_name }}"
+                  echo "―――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――"
+
+                  YEAR="$(date +'%Y')"
+                  echo "YEAR=${YEAR}" >> $GITHUB_ENV
+
+                  NOW="$(date +'%m-%d-%Y %H:%M:%S')"                                                #  02-25-2025 12:49:48
+                  echo "NOW=${NOW}" >> $GITHUB_ENV
+
+                  NOW_SHORT="$(date +'%m-%d-%Y')"                                                   #  02-25-2025
+                  echo "NOW_SHORT=${NOW_SHORT}" >> $GITHUB_ENV
+
+                  NOW_LONG="$(date +'%m-%d-%Y %H:%M')"                                              #  02-25-2025 12:49
+                  echo "NOW_LONG=${NOW_LONG}" >> $GITHUB_ENV
+
+                  NOW_DOCKER="$(date +'%Y%m%d')"                                                    #  20250225
+                  echo "NOW_DOCKER=${NOW_DOCKER}" >> $GITHUB_ENV
+
+                  NOW_DOCKER_TS="$(date -u +'%FT%T.%3NZ')"                                          #  2025-02-25T12:50:11.569Z
+                  echo "NOW_DOCKER_TS=${NOW_DOCKER_TS}" >> $GITHUB_ENV
+
+                  SHA1="$(git rev-parse HEAD)"                                                      #  71fad013cfce9116ec62779e4a7e627fe4c33627
+                  echo "SHA1=${SHA1}" >> $GITHUB_ENV
+
+                  SHA1_GH="$(echo ${GITHUB_SHA})"                                                   #  71fad013cfce9116ec62779e4a7e627fe4c33627
+                  echo "SHA1_GH=${SHA1_GH}" >> $GITHUB_ENV
+
+                  PKG_VER_1DIGIT="$(echo ${{ env.IMAGE_VERSION }} | cut -d '.' -f1-1)"              #  3.22 > 3
+                  echo "PKG_VER_1DIGIT=${PKG_VER_1DIGIT}" >> $GITHUB_ENV
+
+                  PKG_VER_2DIGIT="$(echo ${{ env.IMAGE_VERSION }} | cut -f2 -d ":" | cut -c1-3)"    #  3.22 > 3.2
+                  echo "PKG_VER_2DIGIT=${PKG_VER_2DIGIT}" >> $GITHUB_ENV
+
+                  echo "―――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――"
+                  echo "‎"
+                  echo "‎"
+                  sudo apt -qq update
+                  sudo apt -qq install tree
+                  echo "‎"
+                  echo "‎"
+                  echo "―――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――"
+                  echo "‎"
+                  echo "‎"
+                  echo " Runner .............. ${{ runner.name }}"
+                  echo " Workflow ............ ${{ github.workflow }} (#${{ github.workflow_ref }})"
+                  echo " Run Number .......... ${{ github.run_number }}"
+                  echo " Ref ................. ${{ github.ref }}"
+                  echo " Ref Name ............ ${{ github.ref_name }}"
+                  echo " Event Name .......... ${{ github.event_name }}"
+                  echo " Repo ................ ${{ github.repository }}"
+                  echo " Repo Owner .......... ${{ github.repository_owner }}"
+                  echo " Run ID .............. https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }}"
+                  echo " Triggered By ........ ${{ github.actor }}"
+                  echo " SHA 1 (GITHUB_SHA) .. ${GITHUB_SHA}"
+                  echo " SHA 2 (github.sha) .. ${{ github.sha }}"
+                  echo " SHA 3 (env.SHA1) .... ${SHA1}"
+                  echo " SHA 4 (env.SHA1_GH) . ${SHA1_GH}"
+                  echo " Workspace ........... ${{ github.workspace }}"
+                  echo " PWD ................. ${PWD}"
+                  echo " Job Name ............ ${{ steps.context.outputs.job_name }}"
+                  echo " Job ID .............. ${{ steps.context.outputs.job_id }}"
+                  echo " Job URL ............. ${{ steps.context.outputs.job_url }}"
+                  echo " Run ID .............. ${{ steps.context.outputs.run_id }}"
+                  echo " Run Attempt ......... ${{ steps.context.outputs.run_attempt }}"
+                  echo " Run Number .......... ${{ steps.context.outputs.run_number }}"
+                  echo " Run URL ............. ${{ steps.context.outputs.run_url }}"
+                  echo " Run Env ............. ${{ steps.context.outputs.environment }}"
+                  echo " Run Env URL ......... ${{ steps.context.outputs.environment_url }}"
+                  echo " Run Deployment ...... ${{ steps.context.outputs.deployment_id }}"
+                  echo " Run Deployment URL .. ${{ steps.context.outputs.deployment_url }}"
+                  echo " Run Deployment ...... ${{ steps.context.outputs.deployment_id }}"
+                  echo " Run Runner Name ..... ${{ steps.context.outputs.runner_name }}"
+                  echo " Run Runner ID ....... ${{ steps.context.outputs.runner_id }}"
+                  echo " Year ................ ${YEAR}"
+                  echo " Now ................. ${NOW}"
+                  echo " Now (Short) ......... ${NOW_SHORT}"
+                  echo " Now (Long) .......... ${NOW_LONG}"
+                  echo " Now (Docker) ........ ${NOW_DOCKER}"
+                  echo " Now (Docker TS) ..... ${NOW_DOCKER_TS}"
+                  echo "‎"
+                  echo "‎"
+                  echo "―――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――"
+                  echo "‎"
+                  echo "‎"
+                  tree -I node_modules -I .git
+                  echo "‎"
+                  echo "‎"
+                  echo "―――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――"
+                  echo "‎"
+                  echo "‎"
+
+            # #
+            #   Documentation › Build › Setup Python
             # #
 
             - name: >-
                 🐍 Setup Python
-              id: task_docs_python_setup
               uses: actions/setup-python@v5
               with:
                   python-version: 3.x
 
             # #
-            #   Documentation › Build Documentation
+            #   Documentation › Build › Build
             # #
 
             - name: >-
                 📕 Build Documentation
-              id: task_docs_build
               run: |
                   export DOCS_NAME=${{ secrets.DOCS_NAME || 'TVApp2' }}
                   export DOCS_SECRET_L1=${{ secrets.DOCS_SECRET_L1 }}
@@ -183,12 +334,11 @@ jobs:
                   GH_TOKEN: ${{ secrets.ADMINSERV_TOKEN }}
 
             # #
-            #   Documentation › Deploy
+            #   Documentation › Build › Deploy
             # #
 
             - name: >-
                 💽 Deploy
-              id: task_docs_deploy
               uses: peaceiris/actions-gh-pages@v4
               with:
                   personal_token: ${{ secrets.ADMINSERV_TOKEN_CL }}
@@ -196,33 +346,31 @@ jobs:
 
 
             # #
-            #   Documentation › Get Weekly Commits
+            #   Documentation › Build › Get Weekly Commits
             # #
 
             - name: >-
                 🕛 Get Weekly Commit List
-              id: task_docs_set_weekly_commit_list
               run: |
                   echo 'WEEKLY_COMMITS<<EOF' >> $GITHUB_ENV
                   git log --format="[\`%h\`](${{ github.server_url }}/${{ github.repository }}/commit/%H) %s - %an" --since=7.days >> $GITHUB_ENV
                   echo 'EOF' >> $GITHUB_ENV
 
             # #
-            #   Documentation › Notify Github › Success
+            #   Documentation › Build › Notify Github › Success
             # #
 
             - name: >-
                 🔔 Send Discord Webhook Message (Success)
-              id: task_docs_notify_discord_success
               uses: tsickert/discord-webhook@v7.0.0
               if: success()
               with:
-                  username: 'Io'
+                  username: ${{ env.DISCORD_BOT_NAME }}
-                  avatar-url: 'https://i.imgur.com/8BVDkla.jpg'
+                  avatar-url: ${{ env.DISCORD_BOT_AVATAR }}
                   webhook-url: ${{ secrets.DISCORD_WEBHOOK_CHAN_GITHUB_TVAPP2_WORKfLOWS }}
                   embed-title: "⚙️ ${{ github.workflow_ref }}"
                   embed-url: "https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }}"
-                  embed-thumbnail-url: 'https://i.imgur.com/zDIzE8T.jpg'
+                  embed-thumbnail-url: ${{ env.DISCORD_BOT_EMBED_THUMBNAIL }}
                   embed-description: |
                       ## 📦 Documentation Deployment᲼${{ job.status == 'success' && '✅' || '❌' }}
 
@@ -239,24 +387,23 @@ jobs:
                   embed-timestamp: "${{ env.NOW_LONG }}"
                   embed-author-name: "${{ github.repository_owner }}"
                   embed-author-url: "https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }}"
-                  embed-author-icon-url: "https://avatars.githubusercontent.com/u/200161462"
+                  embed-author-icon-url: ${{ env.DISCORD_BOT_EMBED_AUTHOR_ICON }}
 
             # #
-            #   Documentation › Notify Github › Failure
+            #   Documentation › Build › Notify Github › Failure
             # #
 
             - name: >-
                 🔔 Send Discord Webhook Message (Failure)
-              id: task_docs_notify_discord_failure
               uses: tsickert/discord-webhook@v7.0.0
               if: failure()
               with:
-                  username: 'Io'
+                  username: ${{ env.DISCORD_BOT_NAME }}
-                  avatar-url: 'https://i.imgur.com/8BVDkla.jpg'
+                  avatar-url: ${{ env.DISCORD_BOT_AVATAR }}
                   webhook-url: ${{ secrets.DISCORD_WEBHOOK_CHAN_GITHUB_TVAPP2_WORKfLOWS }}
                   embed-title: "⚙️ ${{ github.workflow_ref }}"
                   embed-url: "https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }}"
-                  embed-thumbnail-url: 'https://i.imgur.com/zDIzE8T.jpg'
+                  embed-thumbnail-url: ${{ env.DISCORD_BOT_EMBED_THUMBNAIL }}
                   embed-description: |
                       ## 📦 Documentation Deployment᲼${{ job.status == 'success' && '✅' || '❌' }}
 
@@ -273,5 +420,5 @@ jobs:
                   embed-timestamp: "${{ env.NOW_LONG }}"
                   embed-author-name: "${{ github.repository_owner }}"
                   embed-author-url: "https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }}"
-                  embed-author-icon-url: "https://avatars.githubusercontent.com/u/200161462"
+                  embed-author-icon-url: ${{ env.DISCORD_BOT_EMBED_AUTHOR_ICON }}