Allow overriding site url in CI

Author: object-Object

.github/workflows/hexdoc.yml

@@ -27,6 +27,10 @@ on:
         description: Subdirectory to deploy the book to
         type: string
         required: false
+      site-url:
+        description: Set the base site url instead of looking up the current repo's GitHub Pages url
+        type: string
+        required: false
       bump-version-segment:
         description: DEPRECATED - This value no longer does anything and is only kept for backwards compatibility.
         type: string
@@ -49,6 +53,7 @@ env:
   HEXDOC_PROPS: ${{ inputs.props }}
   HEXDOC_RELEASE: ${{ inputs.release }}
   HEXDOC_SUBDIRECTORY: ${{ inputs.subdirectory }}
+  GITHUB_PAGES_URL: ${{ inputs.site-url }}
 
 jobs:
   build:

CHANGELOG.md

@@ -9,11 +9,13 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/)
 ### Added
 
 * hexdoc now uses a custom `sys.excepthook` to hide unnecessary traceback frames, except in verbose mode.
+* New reusable workflow input `site-url` to help support non-Pages deployments.
 
 ### Changed
 
 * Adding spoilers to individual pages with the `advancement` field is now supported.
 * Use [`uv`](https://github.com/astral-sh/uv) instead of `pip` for all reusable workflows.
+* `hexdoc ci build` now attempts to read the site url from `HEXDOC_SITE_URL` and `GITHUB_PAGES_URL` environment variables before querying the GitHub API.
 
 ## `1!0.1.0a10`
 

src/hexdoc/cli/ci.py

@@ -34,9 +34,17 @@ def build(
     env = CIEnvironment.model_getenv()
     setup_logging(env.verbosity, ci=True)
 
-    if not (pages_url := os.getenv("MOCK_GITHUB_PAGES_URL")):
+    # FIXME: scuffed. why are we setting environment variables here :/
+    for key in [
+        "MOCK_GITHUB_PAGES_URL",  # highest priority so tests work correctly
+        "HEXDOC_SITE_URL",  # TODO: this should be supported in more places
+        "GITHUB_PAGES_URL",
+    ]:
+        if pages_url := os.getenv(key):
+            break
+    else:
         pages_url = get_pages_url(env.repo)
-        os.environ["GITHUB_PAGES_URL"] = pages_url
+    os.environ["GITHUB_PAGES_URL"] = pages_url
 
     site_path = hexdoc_app.build(
         Path("_site/src/docs"),