diff --git a/.github/workflows/build-docs.yml b/.github/workflows/build-docs.yml index b8b2164354..9e448c374c 100644 --- a/.github/workflows/build-docs.yml +++ b/.github/workflows/build-docs.yml @@ -53,12 +53,12 @@ jobs: id: cache with: path: ${{ env.pythonLocation }} - key: ${{ runner.os }}-python-docs-${{ env.pythonLocation }}-${{ hashFiles('pyproject.toml', 'requirements-docs.txt') }}-v01 + key: ${{ runner.os }}-python-docs-${{ env.pythonLocation }}-${{ hashFiles('pyproject.toml', 'requirements-docs.txt') }}-v02 - name: Install docs extras if: steps.cache.outputs.cache-hit != 'true' run: pip install -r requirements-docs.txt - name: Install Material for MkDocs Insiders - if: ( github.event_name != 'pull_request' || github.secret_source != 'Actions' ) && steps.cache.outputs.cache-hit != 'true' + if: ( github.event_name != 'pull_request' || github.secret_source == 'Actions' ) && steps.cache.outputs.cache-hit != 'true' run: | pip install git+https://${{ secrets.TYPER_MKDOCS_MATERIAL_INSIDERS }}@github.com/squidfunk/mkdocs-material-insiders.git pip install git+https://${{ secrets.TYPER_MKDOCS_MATERIAL_INSIDERS }}@github.com/pawamoy-insiders/griffe-typing-deprecated.git @@ -71,7 +71,7 @@ jobs: if: github.event_name == 'pull_request' && github.secret_source != 'Actions' run: python -m mkdocs build - name: Build Docs with Insiders - if: ( github.event_name != 'pull_request' || github.secret_source != 'Actions' ) + if: ( github.event_name != 'pull_request' || github.secret_source == 'Actions' ) run: python -m mkdocs build --config-file mkdocs.insiders.yml - uses: actions/upload-artifact@v3 diff --git a/docs/release-notes.md b/docs/release-notes.md index 5d656a8376..48ed28ad12 100644 --- a/docs/release-notes.md +++ b/docs/release-notes.md @@ -1,5 +1,10 @@ ## Latest Changes +### Internal + +* 🔧 Temporarily disable social plugin while a MkDocs issue is handled. PR [#779](https://github.com/tiangolo/typer/pull/779) by [@tiangolo](https://github.com/tiangolo). +* 👷 Fix install MkDocs Insiders only when available. PR [#778](https://github.com/tiangolo/typer/pull/778) by [@tiangolo](https://github.com/tiangolo). + ## 0.11.1 ### Fixes diff --git a/mkdocs.insiders.yml b/mkdocs.insiders.yml index 9f2775ff97..7c1870afb7 100644 --- a/mkdocs.insiders.yml +++ b/mkdocs.insiders.yml @@ -1,4 +1,5 @@ INHERIT: mkdocs.yml plugins: - search - - social + # TODO: Re-enable once this is fixed: https://github.com/squidfunk/mkdocs-material/issues/6983 + # - social