ci: rewrite deploy scripts with python3

.github/workflows/delete dev env.yml

@@ -24,6 +24,14 @@ jobs:
         with:
           fetch-depth: 0
 
+      - name: Setup Python
+        uses: actions/setup-python@v6
+        with:
+          python-version: '3.14'
+
+      - name: Install Python Dependency
+        run: pip install requests
+
       - name: Remove Lua Dev Env Modules
         env:
           WIKI_USER: ${{ secrets.LP_BOTUSER }}
@@ -33,4 +41,5 @@ jobs:
           LUA_DEV_ENV_NAME: "dev/${{ github.event.inputs.luadevenv }}"
           INCLUDE_COMMONS: ${{ github.event.inputs.includecommons }}
           INCLUDE_SUB_ENVS: ${{ github.event.inputs.includesubenvs }}
-        run: bash scripts/remove_dev.sh
+          PYTHONUNBUFFERED: 1
+        run: python3 ./scripts/remove_dev.py

.github/workflows/deploy test.yml

@@ -27,6 +27,16 @@ jobs:
           files: |
             lua/wikis/**/*.lua
 
+      - name: Setup Python
+        if: steps.changed-files.outputs.any_changed == 'true'
+        uses: actions/setup-python@v6
+        with:
+          python-version: '3.14'
+
+      - name: Install Python Dependency
+        if: steps.changed-files.outputs.any_changed == 'true'
+        run: pip install requests
+
       - name: Personal Lua Deploy
         if: steps.changed-files.outputs.any_changed == 'true'
         env:
@@ -35,4 +45,5 @@ jobs:
           WIKI_UA_EMAIL: ${{ secrets.LP_UA_EMAIL }}
           WIKI_BASE_URL: ${{ secrets.LP_BASE_URL }}
           LUA_DEV_ENV_NAME: "/dev/${{ github.event.inputs.luadevenv }}"
-        run: bash scripts/deploy.sh "${{ steps.changed-files.outputs.all_changed_files }}"
+          PYTHONUNBUFFERED: 1
+        run: python3 ./scripts/deploy.py ${{ steps.changed-files.outputs.all_changed_files }}

.github/workflows/deploy.yml

@@ -29,6 +29,16 @@ jobs:
             stylesheets/**/*.scss
             javascript/**/*.js
 
+      - name: Setup Python
+        if: steps.res-changed-files.outputs.any_changed == 'true' || steps.lua-changed-files.outputs.any_changed == 'true'
+        uses: actions/setup-python@v6
+        with:
+          python-version: '3.14'
+
+      - name: Install Python Dependency
+        if: steps.res-changed-files.outputs.any_changed == 'true' || steps.lua-changed-files.outputs.any_changed == 'true'
+        run: pip install requests
+
       - name: Resource Deploy
         if: steps.res-changed-files.outputs.any_changed == 'true'
         env:
@@ -37,7 +47,8 @@ jobs:
           WIKI_UA_EMAIL: ${{ secrets.LP_UA_EMAIL }}
           WIKI_BASE_URL: ${{ secrets.LP_BASE_URL }}
           DEPLOY_TRIGGER: ${{ github.event_name }}
-        run: bash scripts/deploy_res.sh "${{ steps.res-changed-files.outputs.all_changed_files }}"
+          PYTHONUNBUFFERED: 1
+        run: python3 ./scripts/deploy_res.py ${{ steps.res-changed-files.outputs.all_changed_files }}
 
       - name: Lua Deploy
         if: steps.lua-changed-files.outputs.any_changed == 'true'
@@ -47,7 +58,8 @@ jobs:
           WIKI_UA_EMAIL: ${{ secrets.LP_UA_EMAIL }}
           WIKI_BASE_URL: ${{ secrets.LP_BASE_URL }}
           DEPLOY_TRIGGER: ${{ github.event_name }}
-        run: bash scripts/deploy.sh "${{ steps.lua-changed-files.outputs.all_changed_files }}"
+          PYTHONUNBUFFERED: 1
+        run: python3 ./scripts/deploy.py ${{ steps.lua-changed-files.outputs.all_changed_files }}
 
       - name: Lua Protect
         if: steps.lua-changed-files.outputs.added_files_count != 0 || steps.lua-changed-files.outputs.renamed_files_count != 0
@@ -56,4 +68,5 @@ jobs:
           WIKI_PASSWORD: ${{ secrets.LP_BOTPASSWORD }}
           WIKI_UA_EMAIL: ${{ secrets.LP_UA_EMAIL }}
           WIKI_BASE_URL: ${{ secrets.LP_BASE_URL }}
-        run: bash scripts/protect.sh "${{ steps.lua-changed-files.outputs.added_files }} ${{ steps.lua-changed-files.outputs.renamed_files }}"
+          PYTHONUNBUFFERED: 1
+        run: python3 ./scripts/protect.py ${{ steps.lua-changed-files.outputs.added_files }} ${{ steps.lua-changed-files.outputs.renamed_files }}

.github/workflows/protect new wiki modules.yml

@@ -16,11 +16,20 @@ jobs:
     steps:
       - uses: actions/checkout@v6
 
+      - name: Setup Python
+        uses: actions/setup-python@v6
+        with:
+          python-version: '3.14'
+
+      - name: Install Python Dependency
+        run: pip install requests
+
       - name: Lua Protect
         env:
           WIKI_USER: ${{ secrets.LP_BOTUSER }}
           WIKI_PASSWORD: ${{ secrets.LP_BOTPASSWORD }}
           WIKI_UA_EMAIL: ${{ secrets.LP_UA_EMAIL }}
           WIKI_BASE_URL: ${{ secrets.LP_BASE_URL }}
           WIKI_TO_PROTECT: ${{ github.event.inputs.wiki }}
-        run: bash scripts/protect.sh
+          PYTHONUNBUFFERED: 1
+        run: python3 ./scripts/protect.py

.github/workflows/protect new wiki templates.yml

@@ -16,11 +16,20 @@ jobs:
     steps:
       - uses: actions/checkout@v6
 
+      - name: Setup Python
+        uses: actions/setup-python@v6
+        with:
+          python-version: '3.14'
+
+      - name: Install Python Dependency
+        run: pip install requests
+
       - name: Template Protect
         env:
           WIKI_USER: ${{ secrets.LP_BOTUSER }}
           WIKI_PASSWORD: ${{ secrets.LP_BOTPASSWORD }}
           WIKI_UA_EMAIL: ${{ secrets.LP_UA_EMAIL }}
           WIKI_BASE_URL: ${{ secrets.LP_BASE_URL }}
           WIKI_TO_PROTECT: ${{ github.event.inputs.wiki }}
-        run: bash scripts/protect_templates.sh
+          PYTHONUNBUFFERED: 1
+        run: python3 ./scripts/protect_templates.py

.github/workflows/pythoncheck.yml

@@ -0,0 +1,22 @@
+name: Python Code Style
+
+on:  
+  pull_request:  
+    paths:  
+      - '**.py'
+      - '.github/workflows/*.yml'
+  workflow_dispatch: 
+
+jobs:
+  python-code-style:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v6
+      - name: Run linter
+        uses: astral-sh/ruff-action@v3
+        with:
+          src: scripts/
+      - name: Check styling
+        run: ruff format --check --diff scripts/

.github/workflows/scheduled.yml

@@ -15,14 +15,23 @@ jobs:
         with:
           fetch-depth: 2
 
+      - name: Setup Python
+        uses: actions/setup-python@v6
+        with:
+          python-version: '3.14'
+
+      - name: Install Python Dependency
+        run: pip install requests
+
       - name: Resource Deploy
         env:
           WIKI_USER: ${{ secrets.LP_BOTUSER }}
           WIKI_PASSWORD: ${{ secrets.LP_BOTPASSWORD }}
           WIKI_UA_EMAIL: ${{ secrets.LP_UA_EMAIL }}
           WIKI_BASE_URL: ${{ secrets.LP_BASE_URL }}
           DEPLOY_TRIGGER: ${{ github.event_name }}
-        run: bash scripts/deploy_res.sh
+          PYTHONUNBUFFERED: 1
+        run: python3 ./scripts/deploy_res.py
 
       - name: Lua Deploy
         env:
@@ -31,4 +40,5 @@ jobs:
           WIKI_UA_EMAIL: ${{ secrets.LP_UA_EMAIL }}
           WIKI_BASE_URL: ${{ secrets.LP_BASE_URL }}
           DEPLOY_TRIGGER: ${{ github.event_name }}
-        run: bash scripts/deploy.sh
+          PYTHONUNBUFFERED: 1
+        run: python3 ./scripts/deploy.py

.gitignore

@@ -5,3 +5,6 @@
 /package-lock.json
 /luacov.report.out
 /luacov.stats.out
+**/__pycache__/
+.env
+*.ck

.vscode/settings.json

@@ -12,6 +12,8 @@
 	"css.validate": false,
 	"less.validate": false,
 	"scss.validate": false,
+	"python.envFile": "${workspaceFolder}/.env",
+	"python.terminal.useEnvFile": true,
 	"workbench.editor.customLabels.patterns": {
 		"**/wikis/*/*.lua": "${dirname}: ${filename}",
 		"**/wikis/*/*/*.lua": "${dirname(-4)}: ${dirname}/${filename}",

scripts/deploy.py

@@ -0,0 +1,73 @@
+import itertools
+import os
+import pathlib
+import re
+import sys
+
+from typing import Iterable
+
+import requests
+
+from deploy_util import (
+    get_git_deploy_reason,
+    deploy_file_to_wiki,
+    read_cookie_jar,
+    read_file_from_path,
+    write_to_github_summary_file,
+)
+from login_and_get_token import get_token
+
+HEADER_PATTERN = re.compile(
+    r"\A---\n" r"-- @Liquipedia\n" r"-- page=(?P<pageName>[^\n]*)\n"
+)
+
+
+def deploy_all_files_for_wiki(
+    wiki: str, file_paths: Iterable[pathlib.Path], deploy_reason: str
+) -> bool:
+    all_modules_deployed = True
+    token = get_token(wiki)
+    with requests.Session() as session:
+        session.cookies = read_cookie_jar(wiki)
+        for file_path in file_paths:
+            print(f"::group::Checking {str(file_path)}")
+            file_content = read_file_from_path(file_path)
+            header_match = HEADER_PATTERN.match(file_content)
+            if not header_match:
+                print("...skipping - no magic comment found")
+                write_to_github_summary_file(f"{str(file_path)} skipped")
+            else:
+                page = header_match.groupdict()["pageName"] + (
+                    os.getenv("LUA_DEV_ENV_NAME") or ""
+                )
+                module_deployed, _ = deploy_file_to_wiki(
+                    session, file_path, file_content, wiki, page, token, deploy_reason
+                )
+                all_modules_deployed &= module_deployed
+            print("::endgroup::")
+    return all_modules_deployed
+
+
+def main():
+    all_modules_deployed = True
+    lua_files: Iterable[pathlib.Path]
+    git_deploy_reason: str
+    if len(sys.argv[1:]) == 0:
+        lua_files = pathlib.Path("./lua/wikis/").rglob("*.lua")
+        git_deploy_reason = "Automated Weekly Re-Sync"
+    else:
+        lua_files = [pathlib.Path(arg) for arg in sys.argv[1:]]
+        git_deploy_reason = get_git_deploy_reason()
+
+    for wiki, files in itertools.groupby(sorted(lua_files), lambda path: path.parts[2]):
+        all_modules_deployed &= deploy_all_files_for_wiki(
+            wiki, list(files), git_deploy_reason
+        )
+
+    if not all_modules_deployed:
+        print("::warning::Some modules were not deployed!")
+        sys.exit(1)
+
+
+if __name__ == "__main__":
+    main()