.github/workflows/docs-deploy.yml

# This is a basic workflow to help you get started with Actions

name: Docs

# Controls when the workflow will run
on: [ push, pull_request ]

# A workflow run is made up of one or more jobs that can run sequentially or in parallel
jobs:
  # This workflow contains a single job called "build"
  build:
    # The type of runner that the job will run on
    runs-on: ubuntu-latest

    # Steps represent a sequence of tasks that will be executed as part of the job
    steps:
      # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
      - uses: actions/checkout@v3
      - uses: actions/[email protected]
      - name: Install Mkdocs
        run: pip install mkdocs mkdocs-material mike

      - name: Set version
        run: echo "RELEASE_VERSION=${GITHUB_REF#refs/*/}" >> $GITHUB_ENV

      - name: Build docs
        run: mike deploy $RELEASE_VERSION
        
      - name: Deploy 🚀
        uses: JamesIves/[email protected]
        with:
          branch: gh-pages # The branch the action should deploy to.
          folder: site # The folder the action should deploy.
1	# This is a basic workflow to help you get started with Actions
2
3	name: Docs
4
5	# Controls when the workflow will run
6	on: [ push, pull_request ]
7
8	# A workflow run is made up of one or more jobs that can run sequentially or in parallel
9	jobs:
10	# This workflow contains a single job called "build"
11	build:
12	# The type of runner that the job will run on
13	runs-on: ubuntu-latest
14
15	# Steps represent a sequence of tasks that will be executed as part of the job
16	steps:
17	# Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
18	- uses: actions/checkout@v3
19	- uses: actions/[email protected]
20	- name: Install Mkdocs
21	run: pip install mkdocs mkdocs-material mike
22
23	- name: Set version
24	run: echo "RELEASE_VERSION=${GITHUB_REF#refs/*/}" >> $GITHUB_ENV
25
26	- name: Build docs
27	run: mike deploy $RELEASE_VERSION
28
29	- name: Deploy 🚀
30	uses: JamesIves/[email protected]
31	with:
32	branch: gh-pages # The branch the action should deploy to.
33	folder: site # The folder the action should deploy.