Skip to content

🔖 Release/0.10.5 (#230) #22

🔖 Release/0.10.5 (#230)

🔖 Release/0.10.5 (#230) #22

Workflow file for this run

name: Build documentation
on:
push:
tags:
- '*'
jobs:
build:
name: Deploy docs
runs-on: ubuntu-latest
steps:
- name: Checkout main
uses: actions/checkout@v3
with:
fetch-depth: 0
- name: Set env
run: echo "RELEASE_VERSION=${GITHUB_REF#refs/*/}" >> $GITHUB_ENV
- name: Set up python
uses: actions/setup-python@v3
with:
python-version: 3.9
- name: Install Poetry
uses: snok/install-poetry@v1
with:
virtualenvs-create: true
virtualenvs-in-project: true
installer-parallel: true
- name: Load cached venv
id: cached-poetry-dependencies
uses: actions/cache@v3
with:
path: .venv
key: venv-${{ runner.os }}-${{ hashFiles('**/poetry.lock') }}
- name: Install dependencies
if: steps.cached-poetry-dependencies.outputs.cache-hit != 'true'
run: poetry install --no-interaction --no-root
- name: Install library
run: poetry install --no-interaction
- name: Build lazydocs
run: |
source .venv/bin/activate
lazydocs --overview-file="index.md" --src-base-url="https://github.com/SatelCreative/satel-spylib/tree/main" --output-path="./docs/api-docs" --validate spylib
- name: Deployment setup
# Use builtin token to deploy
run: |
git config user.name github-actions
git config user.email github-actions@github.com
- name: Deploy document
run: |
echo "RELEASE_TAG_VERSION=${RELEASE_VERSION}"
poetry run mike deploy --push --update-aliases ${RELEASE_VERSION} latest