Merge pull request #53 from endlessm/push-ypsvmqqkxruv

Move GitHub Pages configuration check to Python code

Author: manuq

action.yml

@@ -10,18 +10,6 @@ inputs:
 runs:
   using: composite
   steps:
-    - name: Check that GitHub Pages is correctly configured
-      env:
-        GH_TOKEN: ${{ github.token }}
-      shell: bash
-      run: |
-        if ! gh api "repos/${{ github.repository }}/pages" | jq --exit-status '.build_type == "workflow"'
-        then
-            echo -n "Check that Pages is enabled, with the source set to GitHub Actions, in the " >> "$GITHUB_STEP_SUMMARY"
-            echo "[repository settings](https://github.com/${{ github.repository }}/settings/pages)." >> "$GITHUB_STEP_SUMMARY"
-            exit 1
-        fi
-
     - uses: astral-sh/setup-uv@v6
       with:
         cache-dependency-glob: |

godoctopus.py

@@ -15,6 +15,8 @@
 import requests
 import requests_cache
 
+API = "https://api.github.com"
+
 
 class ConfigurationError(Exception):
     pass
@@ -112,13 +114,13 @@ def _paginate(
             params = None
 
     def get_default_repo_details(self) -> dict[str, Any]:
-        response = self.session.get(f"https://api.github.com/repos/{self.default_repo}")
+        response = self.session.get(f"{API}/repos/{self.default_repo}")
         response.raise_for_status()
         return response.json()
 
     def find_workflow(self) -> dict[str, Any]:
         for workflow in self._paginate(
-            f"https://api.github.com/repos/{self.default_repo}/actions/workflows",
+            f"{API}/repos/{self.default_repo}/actions/workflows",
             item_key="workflows",
         ):
             if workflow["name"] == self.workflow_name:
@@ -133,7 +135,7 @@ def list_branches(self, repo: str) -> list[dict]:
         try:
             return list(
                 self._paginate(
-                    f"https://api.github.com/repos/{repo}/branches",
+                    f"{API}/repos/{repo}/branches",
                 )
             )
         except requests.HTTPError as error:
@@ -155,7 +157,7 @@ def list_pull_requests(self) -> dict[str, list[dict]]:
         branch_prs: dict[str, list[dict]] = {}
 
         for pr in self._paginate(
-            f"https://api.github.com/repos/{self.default_repo}/pulls",
+            f"{API}/repos/{self.default_repo}/pulls",
             params={"state": "all"},
         ):
             branch_prs.setdefault(pr["head"]["label"], []).append(pr)
@@ -178,7 +180,7 @@ def find_artifact(self, artifacts_url: str) -> dict[str, Any] | None:
     def find_latest_artifacts(self, workflow_id: int) -> dict[str, Fork]:
         artifacts: dict[str, Fork] = {}
         for run in self._paginate(
-            f"https://api.github.com/repos/{self.default_repo}/actions/workflows/{workflow_id}/runs",
+            f"{API}/repos/{self.default_repo}/actions/workflows/{workflow_id}/runs",
             params={"status": "success"},
             item_key="workflow_runs",
         ):
@@ -237,9 +239,7 @@ def get_latest_built_release(self) -> Release | None:
         # https://docs.github.com/en/rest/releases/releases?apiVersion=2022-11-28#get-the-latest-release
         # does not allow you to fetch the latest prerelease, and currently all
         # releases in Threadbare are prereleases.
-        for release in self._paginate(
-            f"https://api.github.com/repos/{self.default_repo}/releases"
-        ):
+        for release in self._paginate(f"{API}/repos/{self.default_repo}/releases"):
             if release["draft"]:
                 continue
 
@@ -401,6 +401,29 @@ def run(self) -> None:
         logging.info("Site assembled at %s", tmpdir)
 
 
+def check_pages_configuration(session: requests.Session, repo: str) -> None:
+    logging.debug("Checking GitHub Pages configuration")
+
+    get_response = session.get(f"{API}/repos/{repo}/pages")
+    match get_response.status_code:
+        case 404:
+            logging.debug("GitHub Pages configuration not found")
+        case 200:
+            data = get_response.json()
+            if data["build_type"] == "workflow":
+                logging.debug(
+                    "GitHub Pages is configured correctly for this repository"
+                )
+                return
+        case _:
+            get_response.raise_for_status()
+
+    raise ConfigurationError(
+        "GitHub Pages must be enabled, with the source set to GitHub Actions, in the repository settings.",
+        f"Go to https://github.com/{ repo }/settings/pages to fix this.",
+    )
+
+
 def setup_logging() -> None:
     log_format = "+ %(asctime)s %(levelname)s %(name)s: %(message)s"
     date_format = "%H:%M:%S"
@@ -425,10 +448,13 @@ def main() -> None:
     session = make_session(api_token)
 
     try:
+        check_pages_configuration(session, repo)
+
         amalgamate_pages = AmalgamatePages(session, repo, workflow_name, artifact_name)
         amalgamate_pages.run()
     except ConfigurationError as e:
-        print(f"::error::{e.args[0]}")
+        for message in e.args:
+            print(f"::error::{message}")
         raise
 
     session.cache.delete(older_than=dt.timedelta(days=7))