From 9ae15bfcbdeb384201be4b0dfc464db81bf6b87d Mon Sep 17 00:00:00 2001 From: SWHL Date: Thu, 10 Oct 2024 11:43:30 +0800 Subject: [PATCH] ci: Support multi version docs (#13957) * ci: Support multi version docs * ci: Add newline for codestyle --- ...nts.yml => build_publish_develop_docs.yml} | 8 +++-- .../workflows/build_publish_release_docs.yml | 32 +++++++++++++++++++ mkdocs.yml | 2 ++ 3 files changed, 39 insertions(+), 3 deletions(-) rename .github/workflows/{documents.yml => build_publish_develop_docs.yml} (70%) create mode 100644 .github/workflows/build_publish_release_docs.yml diff --git a/.github/workflows/documents.yml b/.github/workflows/build_publish_develop_docs.yml similarity index 70% rename from .github/workflows/documents.yml rename to .github/workflows/build_publish_develop_docs.yml index b98a4b8e1e..a2d6c7a801 100644 --- a/.github/workflows/documents.yml +++ b/.github/workflows/build_publish_develop_docs.yml @@ -1,4 +1,4 @@ -name: build_document_site +name: Build/Publish Develop Docs on: push: branches: @@ -25,5 +25,7 @@ jobs: path: .cache restore-keys: | mkdocs-material- - - run: pip install mkdocs-material jieba mkdocs-git-revision-date-localized-plugin mkdocs-git-committers-plugin-2 mkdocs-static-i18n - - run: mkdocs gh-deploy --force + - run: pip install mike mkdocs-material jieba mkdocs-git-revision-date-localized-plugin mkdocs-git-committers-plugin-2 mkdocs-static-i18n + - run: | + mike deploy --push --update-aliases main latest + mike set-default --push latest diff --git a/.github/workflows/build_publish_release_docs.yml b/.github/workflows/build_publish_release_docs.yml new file mode 100644 index 0000000000..83c8a6ea7f --- /dev/null +++ b/.github/workflows/build_publish_release_docs.yml @@ -0,0 +1,32 @@ +name: Build/Publish Release Docs +on: + push: + tags: + - v* + +permissions: + contents: write +jobs: + deploy: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - name: Configure Git Credentials + run: | + git config user.name github-actions[bot] + git config user.email github-actions[bot]@users.noreply.github.com + - uses: actions/setup-python@v5 + with: + python-version: 3.x + - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV + - uses: actions/cache@v4 + with: + key: mkdocs-material-${{ env.cache_id }} + path: .cache + restore-keys: | + mkdocs-material- + - run: pip install mike mkdocs-material jieba mkdocs-git-revision-date-localized-plugin mkdocs-git-committers-plugin-2 mkdocs-static-i18n + - run: | + git fetch origin gh-pages --depth=1 + mike deploy --push "${{ github.ref_name }}" latest + mike set-default --push latest diff --git a/mkdocs.yml b/mkdocs.yml index a6606e03d0..10fc13a489 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -241,6 +241,8 @@ extra: link: https://github.com/PaddlePaddle/PaddleOCR - icon: fontawesome/brands/python link: https://pypi.org/project/paddleocr/ + version: + provider: mike extra_javascript: - javascripts/katex.min.js