add cname attribute for custom-domain gh-pages deploy (#1060)

Author: oscarlevin

CHANGELOG.md

@@ -9,6 +9,11 @@ Instructions: Add a subsection under `[Unreleased]` for additions, fixes, change
 
 ## [Unreleased]
 
+### Fixed
+
+- Project-like that are inside a worksheet were not getting solutions in the backmatter.
+- Added an optional `cname` attribute on the `<project>` in the manifest to allow deploy to work with github pages using custom subdomains.
+
 ## [2.28.1] - 2025-08-18
 
 Includes updates to core through commit: [5fd31db](https://github.com/PreTeXtBook/pretext/commit/5fd31dbe840afff119b45bffdaf0921bd7afb1ae)

pretext/project/__init__.py

@@ -1313,6 +1313,9 @@ def server_validator(cls, v: t.List[Server]) -> t.List[Server]:
             raise ValueError("Server names must not be repeated.")
         return v
 
+    # cname attribute on project for writing into a `CNAME` file as part of a deploy.
+    cname: t.Optional[str] = pxml.attr(default=None)
+
     # This validator sets the `_path`, which is provided in the validation context. It can't be loaded from the XML, since this is metadata about the XML (the location of the file it was loaded from).
     # (It's unclear why the typing of the next line is causing issues.)
     @model_validator(mode="after")
@@ -1727,7 +1730,7 @@ def deploy(
             self.stage_deployment()
         if not stage_only:
             utils.publish_to_ghpages(
-                self.stage_abspath(), update_source, no_push=no_push
+                self.stage_abspath(), update_source, no_push=no_push, cname=self.cname
             )
 
     def is_git_managed(self) -> bool:

pretext/utils.py

@@ -685,7 +685,10 @@ def parse_git_remote(string: str) -> t.List[str]:
 
 
 def publish_to_ghpages(
-    directory: Path, update_source: bool, no_push: bool = False
+    directory: Path,
+    update_source: bool,
+    no_push: bool = False,
+    cname: t.Optional[str] = None,
 ) -> None:
     """
     Publish the current project to GitHub pages.
@@ -774,7 +777,9 @@ def publish_to_ghpages(
     log.info("")
     # Should we let ghp_import do the push for us?
     # Should we remove the history?
-    ghp_import.ghp_import(directory, mesg="Latest build deployed.", nojekyll=True)
+    ghp_import.ghp_import(
+        directory, mesg="Latest build deployed.", nojekyll=True, cname=cname
+    )
     log.info(f"Attempting to connect to remote repository at `{origin.url}`...")
     # log.info("(Your SSH password may be required.)")
     log.info("")