Skip to content

fix issue where an outdated version of typeshed can be installed when installing the project if the docstubs have already been generated #610

fix issue where an outdated version of typeshed can be installed when installing the project if the docstubs have already been generated

fix issue where an outdated version of typeshed can be installed when installing the project if the docstubs have already been generated #610

Workflow file for this run

name: docs
# need to deploy pages with a github action since we're copying the readme
on:
push:
branches: ['main']
tags:
- '*'
pull_request:
branches: ['main']
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
contents: write
pages: write
id-token: write
# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
concurrency:
group: 'pages'
cancel-in-progress: false
jobs:
docs:
runs-on: ubuntu-latest
if:
env:
REPO_KEY: ${{ secrets.GH_TOKEN }}
USERNAME: github-actions[bot]
steps:
- name: Checkout
uses: actions/checkout@v4
with:
fetch-depth: 0 # fetch all commits/branches
- uses: actions/setup-python@v5
id: install_python
with:
python-version: 3.12
- 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: install dependencies
run: ./pw uv sync
- name: validate docs
run: ./pw uv run mkdocs build --strict
- name: deploy dev docs
if: github.ref == 'refs/heads/main'
run: ./pw uv run mike deploy --push --update-aliases dev
- name: deploy release docs
if: github.ref_type == 'tag'
run: |
./pw uv run mike deploy --push --update-aliases ${{ github.ref_name }} latest
./pw uv run mike set-default --push latest