| 3 |
name: Docs |
name: Docs |
| 4 |
|
|
| 5 |
# Controls when the workflow will run |
# Controls when the workflow will run |
| 6 |
on: [ push, pull_request ] |
on: |
| 7 |
|
push: |
| 8 |
|
branches: [ main ] |
| 9 |
|
|
| 10 |
# A workflow run is made up of one or more jobs that can run sequentially or in parallel |
# A workflow run is made up of one or more jobs that can run sequentially or in parallel |
| 11 |
jobs: |
jobs: |
| 12 |
# This workflow contains a single job called "build" |
# This workflow contains a single job called "build" |
| 13 |
build: |
docs-deploy: |
| 14 |
# The type of runner that the job will run on |
# The type of runner that the job will run on |
| 15 |
runs-on: ubuntu-latest |
runs-on: ubuntu-latest |
| 16 |
|
|
| 20 |
- uses: actions/checkout@v3 |
- uses: actions/checkout@v3 |
| 21 |
- uses: actions/[email protected] |
- uses: actions/[email protected] |
| 22 |
- name: Install Mkdocs |
- name: Install Mkdocs |
| 23 |
run: pip install mkdocs mkdocs-material mike |
run: pip install mkdocs mkdocs-material |
| 24 |
|
|
| 25 |
- name: Set version |
- name: Set version |
| 26 |
run: echo "RELEASE_VERSION=${GITHUB_REF#refs/*/}" >> $GITHUB_ENV |
run: echo "RELEASE_VERSION=${GITHUB_REF#refs/*/}" >> $GITHUB_ENV |
| 27 |
|
|
| 28 |
- name: Build docs |
- name: Build docs |
| 29 |
run: mike deploy $RELEASE_VERSION |
run: mkdocs build |
| 30 |
|
|
| 31 |
- name: Deploy 🚀 |
- name: Deploy 🚀 |
| 32 |
uses: JamesIves/[email protected] |
uses: JamesIves/[email protected] |
Parent Directory
| 
Revision Log
| 
Patch