Adjust ci

Author: mdellweg

.github/workflows/build.yml

@@ -1,3 +1,4 @@
+---
 name: "Build"
 
 on:
@@ -11,7 +12,7 @@ jobs:
       - name: "Set up Python"
         uses: "actions/setup-python@v5"
         with:
-          python-version: "3.11"
+          python-version: "3.12"
       - name: "Install python dependencies"
         run: |
           pip install build setuptools wheel
@@ -25,3 +26,4 @@ jobs:
           path: |
             dist/
           if-no-files-found: "error"
+...

.github/workflows/docs.yml

@@ -1,22 +1,107 @@
+---
 name: "Docs Test"
 
 on:
   workflow_call:
 
+defaults:
+  run:
+    working-directory: "pulp-docs"
+
 jobs:
-  run-test:
+  build-docs:
     runs-on: "ubuntu-latest"
     steps:
       - uses: "actions/checkout@v4"
+        with:
+          path: "pulp-docs"
+          fetch-depth: 0
+
+      - uses: "actions/checkout@v4"
+        with:
+          repository: "pulp/pulpcore"
+          path: "pulpcore"
+
+      - uses: "actions/checkout@v4"
+        with:
+          repository: "pulp/pulp_ansible"
+          path: "pulp_ansible"
+
+      - uses: "actions/checkout@v4"
+        with:
+          repository: "pulp/pulp_container"
+          path: "pulp_container"
+
+      - uses: "actions/checkout@v4"
+        with:
+          repository: "pulp/pulp_deb"
+          path: "pulp_deb"
+
+      - uses: "actions/checkout@v4"
+        with:
+          repository: "pulp/pulp_gem"
+          path: "pulp_gem"
+
+      - uses: "actions/checkout@v4"
+        with:
+          repository: "pulp/pulp_maven"
+          path: "pulp_maven"
+
+      - uses: "actions/checkout@v4"
+        with:
+          repository: "pulp/pulp_npm"
+          path: "pulp_npm"
+
+      - uses: "actions/checkout@v4"
+        with:
+          repository: "pulp/pulp_ostree"
+          path: "pulp_ostree"
+
+      - uses: "actions/checkout@v4"
+        with:
+          repository: "pulp/pulp_python"
+          path: "pulp_python"
+
+      - uses: "actions/checkout@v4"
+        with:
+          repository: "pulp/pulp_rpm"
+          path: "pulp_rpm"
+
+      - uses: "actions/checkout@v4"
+        with:
+          repository: "pulp/pulp-cli"
+          path: "pulp-cli"
+
+      - uses: "actions/checkout@v4"
+        with:
+          repository: "pulp/pulp-ui"
+          path: "pulp-ui"
+
+      - uses: "actions/checkout@v4"
+        with:
+          repository: "pulp/pulp-openapi-generator"
+          path: "pulp-openapi-generator"
+
+      - uses: "actions/checkout@v4"
+        with:
+          repository: "pulp/pulp-oci-images"
+          path: "pulp-oci-images"
+
+      - uses: "actions/checkout@v4"
+        with:
+          repository: "pulp/pulp-operator"
+          path: "pulp-operator"
+
       - name: "Set up Python"
         uses: "actions/setup-python@v5"
         with:
-          python-version: "3.11"
+          python-version: "3.12"
 
       - name: "Install Test Dependencies"
         run: |
           pip install -r doc_requirements.txt
 
-      - name: Build docs
+      - name: "Build docs"
         run: |
-          make docs
+          mkdocs build
+...

.github/workflows/pr.yml

@@ -8,16 +8,10 @@ concurrency:
   cancel-in-progress: true
 
 jobs:
-  build:
-    uses: "./.github/workflows/build.yml"
-
   docs:
-    needs:
-      - "build"
     uses: "./.github/workflows/docs.yml"
 
   tests:
-    needs: "build"
     uses: "./.github/workflows/tests.yml"
 
   ready-to-ship:

.github/workflows/tests.yml

@@ -11,7 +11,7 @@ jobs:
       - name: "Set up Python"
         uses: "actions/setup-python@v5"
         with:
-          python-version: "3.11"
+          python-version: "3.12"
 
       - name: "Install Test Dependencies"
         run: |

.github/workflows/update-data.yml

@@ -19,7 +19,7 @@ jobs:
       - name: "Set up Python"
         uses: "actions/setup-python@v5"
         with:
-          python-version: "3.11"
+          python-version: "3.12"
 
       - name: "List requirements"
         run: |

mkdocs.yml

@@ -84,19 +84,14 @@ plugins:
           rest_api: "gem"
         - title: "Maven"
           path: "pulp_maven"
-          git_url: "https://github.com/pulp/pulp_python"
+          git_url: "https://github.com/pulp/pulp_maven"
           kind: "Content"
-          rest_api: "python"
+          rest_api: "maven"
         - title: "NPM"
           path: "pulp_npm"
           git_url: "https://github.com/pulp/pulp_npm"
           kind: "Content"
           rest_api: "npm"
-        - title: "RPM"
-          path: "pulp_rpm"
-          git_url: "https://github.com/pulp/pulp_rpm"
-          kind: "Content"
-          rest_api: "rpm"
         - title: "OSTree"
           path: "pulp_ostree"
           git_url: "https://github.com/pulp/pulp_ostree"
@@ -107,6 +102,11 @@ plugins:
           git_url: "https://github.com/pulp/pulp_python"
           kind: "Content"
           rest_api: "python"
+        - title: "RPM"
+          path: "pulp_rpm"
+          git_url: "https://github.com/pulp/pulp_rpm"
+          kind: "Content"
+          rest_api: "rpm"
 
         #TODO Fix cli code paths for docstrings
         - title: "Pulp CLI"

pyproject.toml

@@ -16,6 +16,7 @@ dependencies = [
     "mkdocs-literate-nav~=0.6.1",
     "httpx",
     "rich",
+    "GitPython~=3.1.44",
 ]
 
 [project.scripts]

src/pulp_docs/plugin.py

@@ -5,7 +5,7 @@
 import yaml
 
 import httpx
-from git import Repo
+from git import Repo, GitCommandError
 from mkdocs.config import Config, config_options
 from mkdocs.config.defaults import MkDocsConfig
 from mkdocs.plugins import event_priority, get_plugin_logger, BasePlugin
@@ -252,7 +252,10 @@ def on_files(self, files: Files, /, *, config: MkDocsConfig) -> Files | None:
 
             repository_dir = self.repositories_dir / repository.path
             git_repository_dir = self.repositories_dir / Path(repository.path).parts[0]
-            git_branch = Repo(git_repository_dir).active_branch.name
+            try:
+                git_branch = Repo(git_repository_dir).active_branch.name
+            except TypeError:
+                git_branch = None
             repository_parent_dir = repository_dir.parent
             repository_docs_dir = repository_dir / "staging_docs"
             if repository_docs_dir.exists():
@@ -281,7 +284,7 @@ def on_files(self, files: Files, /, *, config: MkDocsConfig) -> Files | None:
                     else:
                         src_uri = abs_src_path.relative_to(repository_parent_dir)
                     log.debug(f"Adding {abs_src_path} as {src_uri}.")
-                    if repository.git_url:
+                    if repository.git_url and git_branch:
                         git_relpath = abs_src_path.relative_to(git_repository_dir)
                         pulp_meta["edit_url"] = (
                             f"{repository.git_url}/edit/{git_branch}/{git_relpath}"
@@ -314,9 +317,16 @@ def on_files(self, files: Files, /, *, config: MkDocsConfig) -> Files | None:
                     )
                 )
                 repository_nav.add(src_uri)
-                api_json = pulp_docs_git_repository.git.show(
-                    f"docs-data:data/openapi_json/{repository.rest_api}-api.json"
-                )
+                try:
+                    api_json = pulp_docs_git_repository.git.show(
+                        f"docs-data:data/openapi_json/{repository.rest_api}-api.json"
+                    )
+                except GitCommandError:
+                    # Try again on the first remote.
+                    remote = pulp_docs_git_repository.remotes[0]
+                    api_json = pulp_docs_git_repository.git.show(
+                        f"{remote}/docs-data:data/openapi_json/{repository.rest_api}-api.json"
+                    )
                 src_uri = (repository_dir / "api.json").relative_to(
                     repository_parent_dir
                 )