mirror of
https://github.com/openmlsys/openmlsys-zh.git
synced 2026-04-01 18:01:13 +08:00
b9cf38a5d1
Use mdbook-katex in pre-render mode for both books, pin mdBook to a compatible version, update build scripts and workflows, and replace the old MathJax regression tests with KaTeX coverage.
36 lines
1.7 KiB
Python
36 lines
1.7 KiB
Python
from __future__ import annotations
|
|
|
|
import unittest
|
|
from pathlib import Path
|
|
|
|
|
|
REPO_ROOT = Path(__file__).resolve().parents[1]
|
|
WORKFLOW_PATH = REPO_ROOT / ".github" / "workflows" / "update_docs.yml"
|
|
CI_WORKFLOW_PATH = REPO_ROOT / ".github" / "workflows" / "main.yml"
|
|
|
|
|
|
class UpdateDocsWorkflowTests(unittest.TestCase):
|
|
def test_workflow_uses_official_pages_actions_and_page_variables(self) -> None:
|
|
workflow = WORKFLOW_PATH.read_text(encoding="utf-8")
|
|
|
|
self.assertIn("uses: actions/configure-pages@v5", workflow)
|
|
self.assertIn("uses: actions/upload-pages-artifact@v4", workflow)
|
|
self.assertIn("uses: actions/deploy-pages@v4", workflow)
|
|
self.assertIn("url: ${{ steps.deployment.outputs.page_url }}", workflow)
|
|
self.assertIn("${{ steps.pages.outputs.base_url }}", workflow)
|
|
self.assertNotIn("git clone https://x-access-token:${DEPLOY_TOKEN}", workflow)
|
|
|
|
def test_workflows_use_peaceiris_mdbook_action(self) -> None:
|
|
for workflow_path in (WORKFLOW_PATH, CI_WORKFLOW_PATH):
|
|
workflow = workflow_path.read_text(encoding="utf-8")
|
|
self.assertIn("uses: peaceiris/actions-mdbook@v2", workflow, workflow_path.as_posix())
|
|
self.assertIn("mdbook-version: '0.4.48'", workflow, workflow_path.as_posix())
|
|
self.assertNotIn("cargo install mdbook --locked", workflow, workflow_path.as_posix())
|
|
self.assertIn("cargo install mdbook-katex --locked", workflow, workflow_path.as_posix())
|
|
self.assertIn("test_mdbook_katex.py", workflow, workflow_path.as_posix())
|
|
self.assertIn("test_mdbook_katex_config.py", workflow, workflow_path.as_posix())
|
|
|
|
|
|
if __name__ == "__main__":
|
|
unittest.main()
|