gh-pages.yml

# see https://squidfunk.github.io/mkdocs-material/setup/setting-up-versioning/

name: Documentation
on:
  release:
    types: [ created, published ]

  pull_request:
    types:
      - opened
      - reopened
      - synchronize
    paths:
      - 'mkdocs.yml'
      - 'sootup.examples/**'
      - 'docs/**'

permissions:
  contents: write

jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
        with:
          fetch-tags: true
      # to get tag information
      - run: git fetch --prune --unshallow

      - uses: actions/setup-python@v2
        with:
          python-version: 3.x

      - name: install dependencies
        run: pip install mike
      - run: pip install mkdocs-material
      - run: pip install mkdocs-tooltips
      - run: pip install git+https://github.com/RedisLabs/mkdocs-include.git
      - run: pip install git+https://github.com/swissiety/LspLexer4Pygments.git
      # grab latest release url of the JimpleLSP jar and download it
      - run: curl -s -L -o ./jimplelsp.jar $(curl -s https://api.github.com/repos/swissiety/jimpleLsp/releases/latest | grep 'browser_download_url".*jar"' | cut -d ':' -f 2,3 | tr -d \")

      - run: git describe --tags `git rev-list --tags --max-count=1`
      - run: git tag --sort=committerdate

      - name: get latest release tag
        id: "latestgittag"
        run: latestgittagvar="$(git tag --sort=committerdate | grep -E '[0-9]' | tail -1 | cut -b 2-7)"

      - run: echo "[${{steps.latestgittag.outputs.latestgittagvar}}]"

      - name: replace "{{ git_latest_release }}" with latest release tag version in .md files
        run: sed -i 's\{{ git_latest_release }}\'${{steps.latestgittag.outputs.latestgittagvar}}'\g' docs/**.md

      - run: git fetch origin gh-pages --depth=1
      - name: Configure git user
        run: |
          git config --local user.email "github-actions[bot]@users.noreply.github.com"
          git config --local user.name "github-actions[bot]"

      - name: deploy doc in subdirectory (pr)
        if: github.event_name == 'pull_request'
        run: mike deploy ${{ github.head_ref }} --push

      - name: deploy doc in subdirectory (release created)
        if: github.event_name == 'release'
        run: mike deploy ${{ github.ref_name }} --push

      - name: set release as default (release published)
        if: github.event_name == 'release' && github.event.action == 'published'
        run: mike set-default --push ${{ github.ref_name }}