Skip to content

Initial commit: Espilon documentation #1

Initial commit: Espilon documentation

Initial commit: Espilon documentation #1

Workflow file for this run

name: Build and Deploy Documentation
on:
push:
branches:
- main
pull_request:
branches:
- main
workflow_dispatch:
jobs:
build:
name: Build Documentation
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v4
- name: Setup Python
uses: actions/setup-python@v5
with:
python-version: '3.x'
- name: Cache dependencies
uses: actions/cache@v3
with:
path: ~/.cache/pip
key: ${{ runner.os }}-pip-${{ hashFiles('requirements.txt') }}
restore-keys: |
${{ runner.os }}-pip-
- name: Install dependencies
run: pip install -r requirements.txt
- name: Build documentation
run: mkdocs build --strict
- name: Upload build artifacts
uses: actions/upload-artifact@v3
with:
name: docs-site
path: site/
deploy:
name: Deploy to VPS
runs-on: ubuntu-latest
needs: build
if: github.event_name == 'push' && github.ref == 'refs/heads/main'
steps:
- name: Checkout repository
uses: actions/checkout@v4
- name: Deploy via SSH
uses: appleboy/ssh-action@v1.0.3
with:
host: ${{ secrets.VPS_HOST }}
username: ${{ secrets.VPS_USER }}
key: ${{ secrets.VPS_SSH_KEY }}
script: |
cd ${{ secrets.DOCS_PATH || '/opt/espilon-docs' }}
git pull origin main
docker-compose -f docker-compose.docs.yml build
docker-compose -f docker-compose.docs.yml up -d
docker image prune -f