Merge branch 'main' into build-warnings

Author: m-aciek

.github/workflows/cleanup-pr-preview.yml

@@ -0,0 +1,18 @@
+on:
+  pull_request:
+    types:
+      - closed
+jobs:
+  cleanup:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          ref: gh-pages
+      - run: git config user.name "github-actions[bot]"
+      - run: git config user.email "41898282+github-actions[bot]@users.noreply.github.com"
+      - run: git rm ${{ github.ref_name }}
+      - run: git commit -m 'Cleaning up gh-pages after ${{ github.ref_name }}'
+      - uses: ad-m/github-push-action@master

.github/workflows/update.yml

@@ -11,6 +11,7 @@ jobs:
     runs-on: ubuntu-latest
     permissions:
       contents: write
+      pull-requests: write
     steps:
       - uses: actions/setup-python@v5
         with:
@@ -19,7 +20,7 @@ jobs:
       - uses: actions/checkout@v4
       - run: sudo apt-get install -y gettext
       - run: uv run generate.py  # generates "index.html"
-      - run: mkdir -p build && cp index.html style.css warnings* build
+      - run: mkdir -p build && cp index.* style.css warnings* build
       - name: Deploy 🚀
         if: github.event_name != 'pull_request'
         uses: JamesIves/github-pages-deploy-action@v4
@@ -28,6 +29,25 @@ jobs:
           clean: false
           git-config-name: github-actions[bot]
           git-config-email: 41898282+github-actions[bot]@users.noreply.github.com
+      - name: Deploy to subdirectory if pull request 🚀
+        if: github.event_name == 'pull_request'
+        uses: JamesIves/github-pages-deploy-action@v4
+        with:
+          folder: build
+          target-folder: ${{ github.ref_name }}
+          clean: false
+          git-config-name: github-actions[bot]
+          git-config-email: 41898282+github-actions[bot]@users.noreply.github.com
+      - name: Update PR description if pull request
+        if: github.event_name == 'pull_request'
+        uses: chabroA/[email protected]
+        with:
+          auth: ${{ secrets.GITHUB_TOKEN }}
+          repo: ${{ github.event.repository.name }}
+          owner: ${{ github.repository_owner }}
+          pr: ${{ github.event.number }}
+          url: "https://${{ github.repository_owner }}.github.io/${{ github.event.repository.name }}/${{ github.ref_name }}/"
+          message: "📊 Dashboard preview 📊:"
       - name: Debug index.html if pull request
         if: github.event_name == 'pull_request'
         run: |

completion.py

@@ -20,7 +20,7 @@ def branches_from_devguide(devguide_dir: Path) -> list[str]:
     ]
 
 
-def get_completion(clones_dir: str, repo: str) -> tuple[float, 'TranslatorsData']:
+def get_completion(clones_dir: str, repo: str) -> tuple[float, 'TranslatorsData', str]:
     clone_path = Path(clones_dir, repo)
     for branch in branches_from_devguide(Path(clones_dir, 'devguide')) + ['master']:
         try:
@@ -44,7 +44,7 @@ def get_completion(clones_dir: str, repo: str) -> tuple[float, 'TranslatorsData'
             hide_reserved=False,
             api_url='',
         ).completion
-    return completion, translators_data
+    return completion, translators_data, branch
 
 
 @dataclass(frozen=True)

generate.py

@@ -10,11 +10,13 @@
 #     "python-docs-theme",
 # ]
 # ///
+import json
+import concurrent.futures
+import itertools
 import logging
 import subprocess
 from collections.abc import Iterator
-from concurrent.futures import ProcessPoolExecutor
-from dataclasses import dataclass
+from dataclasses import dataclass, asdict
 from datetime import datetime, timezone
 from itertools import repeat
 from pathlib import Path
@@ -51,26 +53,26 @@ def get_completion_progress() -> Iterator['LanguageProjectData']:
         subprocess.run(['make', '-C', cpython_dir / 'Doc', 'venv'], check=True)
         subprocess.run(['make', '-C', cpython_dir / 'Doc', 'gettext'], check=True)
         languages_built = dict(build_status.get_languages(http := PoolManager()))
-        with ProcessPoolExecutor() as executor:
+        with concurrent.futures.ProcessPoolExecutor() as executor:
             return executor.map(
-                get_data,
+                get_project_data,
                 *zip(*get_languages_and_repos(devguide_dir)),
-                repeat(languages_built),
-                repeat(clones_dir),
-                repeat(http),
+                itertools.repeat(languages_built),
+                itertools.repeat(clones_dir),
+                itertools.repeat(http),
             )
 
 
-def get_data(
+def get_project_data(
     language: Language,
-    repo: str,
+    repo: str | None,
     languages_built: dict[str, bool],
     clones_dir: str,
     http: PoolManager,
 ) -> 'LanguageProjectData':
     built = language.code in languages_built
     if repo:
-        completion, translators_data = get_completion(clones_dir, repo)
+        completion, translators_data, branch = get_completion(clones_dir, repo)
         visitors_num = get_number_of_visitors(language.code, http) if built else 0
         warnings = (
             build_warnings.number(clones_dir, repo, language.code) if completion else 0
@@ -80,9 +82,11 @@ def get_data(
         translators_data = TranslatorsData(0, False)
         visitors_num = 0
         warnings = 0
+        branch = None
     return LanguageProjectData(
         language,
         repo,
+        branch,
         completion,
         translators_data,
         visitors_num,
@@ -98,6 +102,7 @@ def get_data(
 class LanguageProjectData:
     language: Language
     repository: str | None
+    branch: str | None
     completion: float
     translators: TranslatorsData
     visitors: int
@@ -114,9 +119,12 @@ class LanguageProjectData:
     template = Template(Path('template.html.jinja').read_text())
 
     output = template.render(
-        completion_progress=list(get_completion_progress()),
+        completion_progress=(completion_progress := list(get_completion_progress())),
         generation_time=generation_time,
         duration=(datetime.now(timezone.utc) - generation_time).seconds,
     )
 
     Path('index.html').write_text(output)
+    Path('index.json').write_text(
+        json.dumps(completion_progress, indent=2, default=asdict)
+    )