From a7b6a2d20ff218e0958c017057f55a91eb3e8367 Mon Sep 17 00:00:00 2001 From: Bernie White Date: Tue, 14 Nov 2023 12:53:25 +1000 Subject: [PATCH] Fix v2 doc publishing (#1665) * Fix v2 doc publishing * Remove main trigger --- .github/workflows/docs.yaml | 44 ++++++++++++++++++++++++++++++++----- mkdocs.yml | 1 + requirements-docs.txt | 8 +++---- 3 files changed, 43 insertions(+), 10 deletions(-) diff --git a/.github/workflows/docs.yaml b/.github/workflows/docs.yaml index 8b64f701b8..f12b3314d4 100644 --- a/.github/workflows/docs.yaml +++ b/.github/workflows/docs.yaml @@ -9,20 +9,20 @@ name: Docs on: push: branches: - - main + - release/v2.9.x workflow_dispatch: permissions: {} jobs: - deploy: + publish: name: Publish docs runs-on: ubuntu-latest permissions: contents: write steps: - name: Checkout - uses: actions/checkout@v3 + uses: actions/checkout@v4 with: fetch-depth: 0 @@ -34,7 +34,7 @@ jobs: - name: Setup Python uses: actions/setup-python@v4 with: - python-version: '3.9' + python-version: '3.11' architecture: 'x64' - name: Install dependencies @@ -43,5 +43,37 @@ jobs: python3 -m pip install wheel python3 -m pip install -r requirements-docs.txt - - name: Deploy site - run: mike deploy --push --update-aliases v2 latest stable --title 'v2' + - name: Generate site + run: mike deploy --push --update-aliases v2 stable --title 'v2' + + deploy: + name: Deploy pages + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + runs-on: ubuntu-latest + needs: [publish] + concurrency: + group: pages + cancel-in-progress: false + permissions: + contents: read + pages: write + id-token: write + steps: + - name: Checkout + uses: actions/checkout@v4 + with: + ref: refs/heads/gh-pages + + - name: Setup Pages + uses: actions/configure-pages@v3 + + - name: Upload artifact + uses: actions/upload-pages-artifact@v2 + with: + path: '.' + + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@v2 diff --git a/mkdocs.yml b/mkdocs.yml index fc7af9826d..f76450d78c 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -72,6 +72,7 @@ nav: - Related projects: related-projects.md - Releases: - Change log: + - v3: 'https://microsoft.github.io/PSRule/v3/CHANGELOG-v3/' - v2: 'CHANGELOG-v2.md' - v1: 'CHANGELOG-v1.md' - v0: 'CHANGELOG-v0.md' diff --git a/requirements-docs.txt b/requirements-docs.txt index 056c54969e..fe9d87dee8 100644 --- a/requirements-docs.txt +++ b/requirements-docs.txt @@ -1,7 +1,7 @@ -mkdocs==1.5.2 -mkdocs-material==9.3.1 -pymdown-extensions==10.3 -mike==1.1.2 +mkdocs==1.5.3 +mkdocs-material==9.4.8 +pymdown-extensions==10.4 +mike==2.0.0 mkdocs-simple-hooks==0.1.5 mkdocs-git-revision-date-plugin==0.3.2 mdx-truly-sane-lists==1.3