FEAT: add --github-pages option to check-dev-files

src/compwa_policy/check_dev_files/__init__.py

@@ -63,6 +63,7 @@
             github_workflows.main,
             allow_deprecated=args.allow_deprecated_workflows,
             doc_apt_packages=_to_list(args.doc_apt_packages),
+            github_pages=args.github_pages,
             python_version=dev_python_version,
             no_macos=args.no_macos,
             no_pypi=args.no_pypi,
@@ -79,7 +80,12 @@
     if is_python_repo:
         executor(black.main, has_notebooks)
         if not args.no_github_actions:
-            executor(release_drafter.main, args.repo_name, args.repo_title)
+            executor(
+                release_drafter.main,
+                args.repo_name,
+                args.repo_title,
+                github_pages=args.github_pages,
+            )
         executor(mypy.main)
         executor(pyright.main)
         executor(pytest.main)
@@ -133,6 +139,12 @@
         required=False,
         type=str,
     )
+    parser.add_argument(
+        "--github-pages",
+        action="store_true",
+        default=False,
+        help="Host documentation on GitHub Pages",
+    )
     parser.add_argument(
         "--keep-issue-templates",
         help="Do not remove the .github/ISSUE_TEMPLATE directory",

src/compwa_policy/check_dev_files/github_workflows.py

@@ -32,6 +32,7 @@
 def main(
     allow_deprecated: bool,
     doc_apt_packages: list[str],
+    github_pages: bool,
     no_macos: bool,
     no_pypi: bool,
     no_version_branches: bool,
@@ -46,6 +47,7 @@
         _update_ci_workflow,
         allow_deprecated,
         doc_apt_packages,
+        github_pages,
         no_macos,
         python_version,
         single_threaded,
@@ -95,6 +97,7 @@
 def _update_ci_workflow(
     allow_deprecated: bool,
     doc_apt_packages: list[str],
+    github_pages: bool,
     no_macos: bool,
     python_version: PythonVersion,
     single_threaded: bool,
@@ -105,6 +108,7 @@
         yaml, expected_data = _get_ci_workflow(
             COMPWA_POLICY_DIR / CONFIG_PATH.github_workflow_dir / "ci.yml",
             doc_apt_packages,
+            github_pages,
             no_macos,
             python_version,
             single_threaded,
@@ -139,6 +143,7 @@
 def _get_ci_workflow(
     path: Path,
     doc_apt_packages: list[str],
+    github_pages: bool,
     no_macos: bool,
     python_version: PythonVersion,
     single_threaded: bool,
@@ -147,14 +152,17 @@
 ) -> tuple[YAML, dict]:
     yaml = create_prettier_round_trip_yaml()
     config = yaml.load(path)
-    __update_doc_section(config, doc_apt_packages, python_version)
+    __update_doc_section(config, doc_apt_packages, python_version, github_pages)
     __update_pytest_section(config, no_macos, single_threaded, skip_tests, test_extras)
     __update_style_section(config, python_version)
     return yaml, config
 
 
 def __update_doc_section(
-    config: CommentedMap, apt_packages: list[str], python_version: PythonVersion
+    config: CommentedMap,
+    apt_packages: list[str],
+    python_version: PythonVersion,
+    github_pages: bool,
 ) -> None:
     if not os.path.exists("docs/"):
         del config["jobs"]["doc"]
@@ -164,7 +172,7 @@
             with_section["python-version"] = DoubleQuotedScalarString(python_version)
         if apt_packages:
             with_section["apt-packages"] = " ".join(apt_packages)
-        if not CONFIG_PATH.readthedocs.exists():
+        if not CONFIG_PATH.readthedocs.exists() or github_pages:
             with_section["gh-pages"] = True
         __update_with_section(config, job_name="doc")
 

src/compwa_policy/check_dev_files/release_drafter.py

@@ -10,14 +10,14 @@
 from compwa_policy.utilities.yaml import create_prettier_round_trip_yaml
 
 
-def main(repo_name: str, repo_title: str) -> None:
+def main(repo_name: str, repo_title: str, github_pages: bool) -> None:
     update_file(CONFIG_PATH.release_drafter_workflow)
-    _update_draft(repo_name, repo_title)
+    _update_draft(repo_name, repo_title, github_pages)
 
 
-def _update_draft(repo_name: str, repo_title: str) -> None:
+def _update_draft(repo_name: str, repo_title: str, github_pages: bool) -> None:
     yaml = create_prettier_round_trip_yaml()
-    expected = _get_expected_config(repo_name, repo_title)
+    expected = _get_expected_config(repo_name, repo_title, github_pages)
     output_path = CONFIG_PATH.release_drafter_config
     if not os.path.exists(output_path):
         yaml.dump(expected, output_path)
@@ -30,14 +30,16 @@
         raise PrecommitError(msg)
 
 
-def _get_expected_config(repo_name: str, repo_title: str) -> dict[str, Any]:
+def _get_expected_config(
+    repo_name: str, repo_title: str, github_pages: bool
+) -> dict[str, Any]:
     yaml = create_prettier_round_trip_yaml()
     config = yaml.load(COMPWA_POLICY_DIR / CONFIG_PATH.release_drafter_config)
     key = "name-template"
     config[key] = config[key].replace("<<REPO_TITLE>>", repo_title)
     key = "template"
     lines = config[key].split("\n")
-    if not os.path.exists(CONFIG_PATH.readthedocs):
+    if not os.path.exists(CONFIG_PATH.readthedocs) or github_pages:
         lines = lines[2:]
     config[key] = "\n".join(lines).replace("<<REPO_NAME>>", repo_name)
     return config