Skip to content

Documentation System Requirement Specification (SRS) (#626) #63

Documentation System Requirement Specification (SRS) (#626)

Documentation System Requirement Specification (SRS) (#626) #63

Workflow file for this run

name: 'Deploy Documentation'
# when changes are made to the documentation, build and deploy it to GitHub Pages
on:
push:
branches: ['main']
paths:
- 'docs/**/*.md'
workflow_dispatch:
permissions:
contents: read
pages: write
id-token: write
concurrency:
group: 'pages'
cancel-in-progress: true
jobs:
build:
name: 'Build Documentation'
runs-on: ubuntu-latest
defaults:
run:
working-directory: ./docs/guide
steps:
- name: 'Checkout Repo'
uses: actions/checkout@v2
- name: 'Setup mdBook'
run: |
mkdir bin
curl -sSL https://github.com/rust-lang/mdBook/releases/download/v0.4.25/mdbook-v0.4.25-x86_64-unknown-linux-gnu.tar.gz | tar -xz --directory=bin
- name: 'Build Documentation'
run: bin/mdbook build
- name: 'Upload Docs'
uses: actions/upload-pages-artifact@v1
with:
path: ./docs/guide/book
deploy_pages:
name: 'Deploy Documentation'
needs: build
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v1