Skip to content

Merge pull request #144 from thchatzidiamantis/dcomp #111

Merge pull request #144 from thchatzidiamantis/dcomp

Merge pull request #144 from thchatzidiamantis/dcomp #111

Workflow file for this run

# This is a basic workflow to help you get started with Actions
name: Build and Deploy MkDocs to GitHub Pages
permissions:
contents: write
# Controls when the workflow will run
on:
# Triggers the workflow on push or pull request events but only for the master branch
push:
branches: [main]
paths:
- src/**
- custom_theme/**
- mkdocs.yml
- requirements.txt
- .github/workflows/mkdocs.yml
# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:
# 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"
mkdocs:
# 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
- name: 📥 Checkout repository
uses: actions/checkout@v3
- name: 🔨 Build MkDocs
uses: Tiryoh/actions-mkdocs@v0
with:
mkdocs_version: 'latest' # option
#mkdocs_version: '1.1' # option
requirements: 'requirements.txt' # option
configfile: 'mkdocs.yml' # option
- name: 📘 Publish Generated MkDocs
uses: JamesIves/github-pages-deploy-action@v4
with:
token: ${{ secrets.GITHUB_TOKEN }}
folder: site