Skip to content

Preparations, bug fixing pre 2.0.0 #485

Preparations, bug fixing pre 2.0.0

Preparations, bug fixing pre 2.0.0 #485

Workflow file for this run

name: Build and Deploy Documentation
on:
push:
branches:
- main
permissions:
contents: write
pages: write
id-token: write
jobs:
deploy:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Configure Git Credentials
run: |
git config user.name github-actions[bot]
git config user.email 41898282+github-actions[bot]@users.noreply.github.com
- name: Setup PHP
uses: shivammathur/setup-php@v2
with:
php-version: '8.3'
tools: composer
- name: Install PHP dependencies
run: composer install --no-dev --optimize-autoloader
- name: Rebuild autoloader
run: composer dump-autoload --optimize
- name: Generate MkDocs documentation
run: php bin/instructor-docs gen:mkdocs
- uses: actions/setup-python@v5
with:
python-version: 3.x
- run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
- uses: actions/cache@v4
with:
key: mkdocs-material-${{ env.cache_id }}
path: .cache
restore-keys: |
mkdocs-material-
- name: Install MkDocs dependencies
run: |
pip install mkdocs-material
pip install mkdocs-material[imaging]
- name: Deploy to GitHub Pages
run: mkdocs gh-deploy --force
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}