1
0
mirror of https://github.com/lensapp/lens.git synced 2025-05-20 05:10:56 +00:00

Documentation Update: Properly create tags and aliases, add workflow to delete unwanted / old versions (#1355)

Signed-off-by: Mario Sarcher <msarcher@mirantis.com>

Documentation: only create new tag and update alias "latest" on release publish (not for pre-releases), master contains always the docs generated from last master branch commit

Signed-off-by: Mario Sarcher <msarcher@mirantis.com>

Documentation: only create new tag and update alias "latest" on release publish (not for pre-releases), master contains always the docs generated from last master branch commit

Signed-off-by: Mario Sarcher <msarcher@mirantis.com>

Generate pre-release docs until Lens 4.0.0 is GA, see #1408

Signed-off-by: Mario Sarcher <msarcher@mirantis.com>

Co-authored-by: Mario Sarcher <msarcher@mirantis.com>
This commit is contained in:
Mario Sarcher 2020-11-17 10:38:58 +01:00 committed by GitHub
parent 532b10e357
commit dba4b36e96
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 55 additions and 14 deletions

View File

@ -3,7 +3,9 @@ on:
push:
branches:
- master
release:
types:
- published
jobs:
build:
name: Deploy docs
@ -27,13 +29,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
@ -45,17 +46,19 @@ jobs:
yarn install
yarn typedocs-extensions-api
- name: mkdocs deploy latest
- name: mkdocs deploy master
if: contains(github.ref, 'refs/heads/master')
run: |
mike deploy --push latest
mike deploy --push master
- name: Get the release version
if: contains(github.ref, 'refs/tags/v') # && !github.event.release.prerelease (generate pre-release docs until Lens 4.0.0 is GA, see #1408)
id: get_version
run: echo ::set-output name=VERSION::${GITHUB_REF/refs\/tags\//}
- name: mkdocs deploy new release / tag
if: contains(github.ref, 'refs/tags/v')
- name: mkdocs deploy new release
if: contains(github.ref, 'refs/tags/v') # && !github.event.release.prerelease (generate pre-release docs until Lens 4.0.0 is GA, see #1408)
run: |
mike deploy --push--update-aliases ${{ github.ref }} latest
mike set-default --push ${{ github.ref }}
mike deploy --push --update-aliases ${{ steps.get_version.outputs.VERSION }} latest
mike set-default --push ${{ steps.get_version.outputs.VERSION }}

View File

@ -0,0 +1,38 @@
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 git+https://${{ secrets.GH_TOKEN }}@github.com/lensapp/mkdocs-material-insiders.git
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 }}