-
Notifications
You must be signed in to change notification settings - Fork 60
34 lines (32 loc) · 1.14 KB
/
publish-docs-new-version.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
# This workflow needs to be triggered manually to create a
# new version of the documentation.
#
# This workflow needs to live in default branch to be able
# to be triggered manually due to a limitation of github actions.
# Make sure to select the branch `docs/main` when triggering this action
name: publish-docs-new-version
on:
workflow_dispatch:
inputs:
version:
description: 'Input the version that needs to be deployed. For example 2.0.0 (and make sure you select the branch docs/main when triggering this action.)'
required: true
jobs:
publish:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v4
with:
python-version: 3.x
- run: git fetch origin gh-pages --depth=1
- run: |
git config user.name github-actions
git config user.email github-actions@github.com
- run: |
pip install mkdocs-material
pip install mike
# deploy this version and set alias to latest
- run: |
mike deploy --push --update-aliases ${{ github.event.inputs.version }} latest
mike list