From 61fc7fdc9c0cfcb5484b275af8ea91aa17c9980b Mon Sep 17 00:00:00 2001 From: Mario Sarcher Date: Thu, 12 Nov 2020 17:00:04 +0100 Subject: [PATCH 1/2] Fix mkdocs deployment GH-Action to properly create tags and aliases + Add new workflow to manually delete old or unwanted doc versions Signed-off-by: Mario Sarcher --- .github/workflows/main.yml | 18 +++++----- .github/workflows/mkdocs-delete-version.yml | 37 +++++++++++++++++++++ 2 files changed, 45 insertions(+), 10 deletions(-) create mode 100644 .github/workflows/mkdocs-delete-version.yml diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index 6560efcc11..a117b24ac0 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -3,7 +3,8 @@ on: push: branches: - master - + tags: + - 'v*' jobs: build: name: Deploy docs @@ -27,13 +28,12 @@ jobs: - name: Checkout Release from lens uses: actions/checkout@v2 with: - repository: lensapp/lens + fetch-depth: 0 - name: git config run: | git config --local user.email "action@github.com" git config --local user.name "GitHub Action" - git pull - name: Using Node.js ${{ matrix.node-version }} uses: actions/setup-node@v1 @@ -46,16 +46,14 @@ jobs: yarn typedocs-extensions-api - name: mkdocs deploy latest + if: contains(github.ref, 'refs/heads/master') run: | - mike deploy --push latest + mike deploy --push --update-aliases master latest - name: mkdocs deploy new release / tag if: contains(github.ref, 'refs/tags/v') run: | - mike deploy --push--update-aliases ${{ github.ref }} latest - mike set-default --push ${{ github.ref }} - - - - + VERSION=$(git describe --tags `git rev-list --tags --max-count=1`) + mike deploy --push --update-aliases $VERSION latest + mike set-default --push $VERSION \ No newline at end of file diff --git a/.github/workflows/mkdocs-delete-version.yml b/.github/workflows/mkdocs-delete-version.yml new file mode 100644 index 0000000000..fa632da5e2 --- /dev/null +++ b/.github/workflows/mkdocs-delete-version.yml @@ -0,0 +1,37 @@ +name: Delete Documentation Version +on: + workflow_dispatch: + inputs: + version: + description: 'Version string to be deleted (e.g."v0.0.1")' + required: true +jobs: + build: + name: Delete docs Version + runs-on: ubuntu-latest + steps: + - name: Set up Python 3.7 + uses: actions/setup-python@v2 + with: + python-version: '3.x' + + - name: Install dependencies + run: | + python -m pip install --upgrade pip + pip install mkdocs-material + pip install mike + + - name: Checkout Release from lens + uses: actions/checkout@v2 + with: + fetch-depth: 0 + + - name: git config + run: | + git config --local user.email "action@github.com" + git config --local user.name "GitHub Action" + + + - name: mkdocs delete version + run: | + mike delete --push ${{ github.event.inputs.version \ No newline at end of file From 24f37711c76ae045384d89edb2c24657267f85b2 Mon Sep 17 00:00:00 2001 From: Mario Sarcher Date: Thu, 12 Nov 2020 17:07:22 +0100 Subject: [PATCH 2/2] Fix variable usage and use mkdocs-material-insiders repo Signed-off-by: Mario Sarcher --- .github/workflows/mkdocs-delete-version.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/mkdocs-delete-version.yml b/.github/workflows/mkdocs-delete-version.yml index fa632da5e2..826abea0ea 100644 --- a/.github/workflows/mkdocs-delete-version.yml +++ b/.github/workflows/mkdocs-delete-version.yml @@ -18,7 +18,7 @@ jobs: - name: Install dependencies run: | python -m pip install --upgrade pip - pip install mkdocs-material + pip install git+https://${{ secrets.GH_TOKEN }}@github.com/lensapp/mkdocs-material-insiders.git pip install mike - name: Checkout Release from lens @@ -34,4 +34,4 @@ jobs: - name: mkdocs delete version run: | - mike delete --push ${{ github.event.inputs.version \ No newline at end of file + mike delete --push ${{ github.event.inputs.version }} \ No newline at end of file