updating 3.4 for gh-pages

Author: niden

.github/workflows/deploy-documents.yml

@@ -1,12 +1,15 @@
-name: Deploy Documents
+# Workflow inspiration and adaptation came from Andruino-Cli
+# https://github.com/arduino/arduino-cli/blob/master/.github/workflows/deploy-cobra-mkdocs-versioned-poetry.yml
+
+name: Deploy Documents 5.8
 
 env:
   PYTHON_VERSION: "3.9"
 
 on:
   push:
     branches:
-      # Branch to base "dev" website on. Set in siteversion.py also.
+      # Branch to base "dev" website on.
       - master
       # Release branches have names like 0.8.x, 0.9.x, ...
       - "[0-9]+.[0-9]+.x"
@@ -50,37 +53,56 @@ jobs:
           python -m pip install --upgrade pip
           python -m pip install -r requirements.txt
 
-      #      - name: Create all generated documentation content
-      #        run: mkdocs build
-      #
+      - name: Get sponsors and fanart
+        run: |
+          wget -O docs/assets/sponsors.md \
+            https://raw.githubusercontent.com/phalcon/assets/master/phalcon/sponsors-fragment.html
+          wget -O overrides/fanart.md \
+            https://raw.githubusercontent.com/phalcon/assets/master/phalcon/fanart-fragment.html
+
+      - name: Update NFR list
+        run: |
+          python ./update-nfr.py
+
       - name: Determine versioning parameters
         id: determine-versioning
         run: |
           # Read the first line from the VERSION file
           LINE=$(head -n 1 ./VERSION)
-          
+
           # Extract version and alias using parameter expansion
           VERSION="${LINE%%|*}"
           ALIAS="${LINE#*|}"
-          
+
           # Print the extracted values for verification
           echo "Version: $VERSION"
           echo "Alias: $ALIAS"
-          
+
           echo "PH_DOCS_VERSION=$VERSION" >> $GITHUB_ENV
           echo "PH_DOCS_ALIAS=$ALIAS" >> $GITHUB_ENV
 
       - name: Deploy
         if: ${{ env.PH_DOCS_VERSION }} != null
         run: |
-          # Publishing implies creating a git commit on the production branch, 
-          # we let @phalconbot own these commits.
+          # Publishing implies creating a git commit on the production branch,
+          # We will need to create a user for this at some point
+          echo "Deploying with Mike"
           git config user.name niden
           git config user.email [email protected]
-          git fetch --no-tags --prune --depth=1 origin +refs/heads/production:refs/remotes/origin/production
+          git fetch --no-tags --prune --depth=1 origin +refs/heads/gh-pages:refs/remotes/origin/gh-pages
           mike deploy \
             --update-aliases \
-            --branch production \
+            --alias-type=redirect \
             --push \
             ${{ env.PH_DOCS_VERSION }} \
             ${{ env.PH_DOCS_ALIAS }}
+          echo "Deployed"
+
+#          git fetch --no-tags --prune --depth=1 origin +refs/heads/production:refs/remotes/origin/production
+#          mike deploy \
+#            --update-aliases \
+#            --alias-type=redirect \
+##            --branch production \
+#            --push \
+#            ${{ env.PH_DOCS_VERSION }} \
+#            ${{ env.PH_DOCS_ALIAS }}

mkdocs.yml

@@ -2070,7 +2070,6 @@ plugins:
 # Additional configuration
 extra:
   version:
-    default: 5.4.0
     provider: mike
   analytics:
     provider: google
@@ -2145,27 +2144,31 @@ nav:
   - Home:
       - Introduction: introduction.md
       - Changelog:
-        - Current Version: https://github.com/phalcon/cphalcon/tree/master/resources
+          - Current Version: https://github.com/phalcon/cphalcon/blob/5.0.x/CHANGELOG-5.0.md
+          - Releases: releases.md
+          - How to upgrade: upgrade.md
       - Contributing:
-        - Contributions: contributions.md
-        - Asking a question: https://phalcon.io/discussions
-        - Requesting a change: new-feature-request.md
-        - Issuing a Pull Request: new-pull-request.md
+          - Contributions: contributions.md
+          - Asking a question: https://phalcon.io/discussions
+          - Requesting a change: new-feature-request.md
+          - Issuing a Pull Request: new-pull-request.md
       - Guides:
-        - Backtrace Generation: generating-backtrace.md
-        - Reproducible Tests: reproducible-tests.md
+          - Backtrace Generation: generating-backtrace.md
+          - Reproducible Tests: reproducible-tests.md
+          - Testing environment: testing-environment.md
+          - Coding Standard: coding-standard.md
       - Sponsoring: sponsors.md
   - Getting Started:
       - Installation: installation.md
       - Webserver Setup: webserver-setup.md
       - WAMP: webserver-wamp.md
       - XAMPP: webserver-xampp.md
       - Environments:
-        - Nanobox: environments-nanobox.md
+          - Nanobox: environments-nanobox.md
       - Development Tools:
-        - Installation: devtools-installation.md
-        - Usage: devtools-usage.md
-        - Debug: debug.md
+          - Installation: devtools-installation.md
+          - Usage: devtools-usage.md
+          - Debug: debug.md
       - Tutorials:
           - Basic: tutorial-basic.md
           - Invo: tutorial-invo.md
@@ -2179,7 +2182,6 @@ nav:
       - DI Container: di.md
       - MVC: mvc.md
       - Namespaces: namespaces.md
-      - API Index: api/index.md
   - Database:
       - Layer: db-layer.md
       - PHQL: db-phql.md

update-nfr.py

@@ -0,0 +1,50 @@
+import requests
+import json
+
+print("Getting NFR Reactions")
+
+comments = 'https://api.github.com/repos/phalcon/cphalcon/issues/14608/comments?page='
+result = {}
+for i in range(1, 10):
+    url = f"{comments}{i}"
+    headers = {
+        'Accept': 'application/vnd.github.squirrel-girl-preview+json',
+        'User-Agent': 'Phalcon Agent'
+    }
+
+    response = requests.get(url, headers=headers)
+    content = response.text
+
+    print(f"Got content {i}")
+    data = json.loads(content)
+
+    for comment in data:
+        id = comment.get('id', '')
+        url = comment.get('html_url', '')
+        body = comment.get('body', '')
+        reactions = comment.get('reactions', {})
+        plusone = reactions.get('+1', 0)
+
+        body = body.split('\n')[0].replace('\r', '').replace('\r\n', '')
+        plusone = f"{int(plusone):03}"
+        result[f"{plusone}-{id}"] = {
+            'reaction': plusone,
+            'body': f"[{body}]({url})"
+        }
+
+print("Sorting Results")
+sorted_result = dict(sorted(result.items(), key=lambda item: item[0], reverse=True))
+
+print("Creating Content")
+output = "# New Feature Request List\n"
+output += "- - -\n\n"
+output += "| Votes  | Description             |\n"
+output += "|--------|-------------------------|\n"
+for item in sorted_result.values():
+    output += f"| {item['reaction']} | {item['body']} |\n"
+
+output += "\n"
+
+file_name = 'docs/new-feature-request-list.md'
+with open(file_name, 'w') as file:
+    file.write(output)