build_and_publish_docs.yml

name: build_and_publish_docs

on:
  push:
    branches:
    - dev
    - master
    - test/**
    tags:
    - v[0-9]+.[0-9]+.[0-9]+
  pull_request:
    branches:
    - dev
  workflow_dispatch:

concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: ${{ github.ref != 'refs/heads/dev' && github.ref != 'refs/heads/master' }}

jobs:
  publish:
    name: build and publish docs
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
        with:
          fetch-depth: 0

      - name: set up python 3.9
        uses: actions/setup-python@v5
        with:
          python-version: 3.9

      - uses: r-lib/actions/setup-pandoc@v2
        with:
          pandoc-version: '3.1.6'

      - name: setup poetry and install dependencies
        run: |
          python -m pip install --upgrade pip poetry
          python -m poetry install --with tutorials,docs --all-extras --no-ansi --no-interaction

      - name: save docs version into a variable
        run: |
          echo "DOC_VERSION=${{ github.head_ref || github.ref_name }}" >> $GITHUB_ENV

      - name: build documentation
        env:
          TG_BOT_TOKEN: ${{ secrets.TG_BOT_TOKEN }}
          TG_BOT_USERNAME: ${{ secrets.TG_BOT_USERNAME }}
          DOC_VERSION: ${{ env.DOC_VERSION }}
        run: |
          python -m poetry run poe docs

      - name: deploy website
        uses: JamesIves/github-pages-deploy-action@v4
        with:
          branch: gh-pages
          folder: docs/build/
          target-folder: ${{ env.DOC_VERSION }}
          clean: True

      - name: print link to the documentation
        run: |
          echo "https://deeppavlov.github.io/chatsky/${{ github.head_ref || github.ref_name }}"