.github/workflows/docs-deploy.yml

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

name: Deploy Docs

# Controls when the workflow will run
on:
  push:
    branches: [ main ]

# 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"
  docs-deploy:
    # 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

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

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