Skip to content

Documentation(Deploy) #193

Documentation(Deploy)

Documentation(Deploy) #193

Workflow file for this run

name: Documentation(Deploy)
on:
push:
branches:
- main
schedule: # run every week
- cron: '0 0 * * 0'
concurrency:
group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
cancel-in-progress: true
# See: https://github.com/pdm-project/pdm/issues/1879
env:
PDM_DEPS: 'urllib3<2'
jobs:
documentation:
name: Deploy documentation
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0
- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: 3.11
- uses: pdm-project/setup-pdm@v4
name: Setup PDM
with:
python-version: 3.11
- name: Install dependencies
run: pdm install
- name: Set up build cache
uses: actions/cache@v4
id: cache
with:
key: mkdocs-material-${{ github.ref }}
path: .cache
restore-keys: |
mkdocs-material-
# derived from:
# https://github.com/RemoteCloud/public-documentation/blob/dev/.github/workflows/build_docs.yml
- 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: Depoly documentation
env:
GH_TOKEN: ${{ secrets.GH_TOKEN }}
GOOGLE_ANALYTICS_KEY: ${{ secrets.GOOGLE_ANALYTICS_KEY }}
run: |
version=$(pdm run python3 -c "import bloqade; print(bloqade.__version__)")
git fetch origin gh-pages --depth=1
pdm run mike deploy --push --update-alias $version latest