ci: Dynamic CI_PAGES_URL when building GitHub Pages and ReadTheDocs. (#…

…299)
serious-scaffold · Feb 1, 2024 · 37c0502 · 37c0502
1 parent 571382e
commit 37c0502
Show file tree

Hide file tree

Showing 4 changed files with 12 additions and 4 deletions.
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -10,9 +10,12 @@ jobs:
         with:
           cache: true
           python-version: '3.12'
+      - id: pages
+        name: Setup pages
+        uses: actions/configure-pages@v4
       - run: env | sort
       - run: make dev-doc
-      - run: make doc
+      - run: CI_PAGES_URL=${{ steps.pages.outputs.base_url }} make doc
       - name: Upload changelog
         uses: actions/upload-artifact@v4
         with:

diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -4,12 +4,13 @@ build:
       - make doc-mypy
       - make doc-coverage
     post_checkout:
+      - env | sort
       - git fetch --unshallow || true
     post_install:
       - python -m pip install --upgrade --no-cache-dir pdm
       - make dev-doc
     pre_build:
-      - make changelog
+      - CI_PAGES_URL=https://${READTHEDOCS_PROJECT}.readthedocs.io/${READTHEDOCS_LANGUAGE}/stable make changelog
   os: ubuntu-22.04
   tools:
     python: '3'

diff --git a/template/.readthedocs.yaml b/template/.readthedocs.yaml
@@ -4,12 +4,13 @@ build:
       - make doc-mypy
       - make doc-coverage
     post_checkout:
+      - env | sort
       - git fetch --unshallow || true
     post_install:
       - python -m pip install --upgrade --no-cache-dir pdm
       - make dev-doc
     pre_build:
-      - make changelog
+      - CI_PAGES_URL=https://${READTHEDOCS_PROJECT}.readthedocs.io/${READTHEDOCS_LANGUAGE}/stable make changelog
   os: ubuntu-22.04
   tools:
     python: '3'

diff --git a/...ate/[% if repo_host_type == 'github.com' %].github[% endif %]/workflows/release.yml.jinja b/...ate/[% if repo_host_type == 'github.com' %].github[% endif %]/workflows/release.yml.jinja
@@ -11,9 +11,12 @@ jobs:
         with:
           cache: true
           python-version: '{{ default_py }}'
+      - id: pages
+        name: Setup pages
+        uses: actions/configure-pages@v4
       - run: env | sort
       - run: make dev-doc
-      - run: make doc
+      - run: CI_PAGES_URL={{ '${{ steps.pages.outputs.base_url }}' }} make doc
       - name: Upload changelog
         uses: actions/upload-artifact@v4
         with: