Skip to content

docs/README.md: add dev notes for CDSP documentation site #115

docs/README.md: add dev notes for CDSP documentation site

docs/README.md: add dev notes for CDSP documentation site #115

Workflow file for this run

name: Standard Build Check
on: [push, pull_request]
jobs:
docgen:
name: Documentation Generation
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
with:
submodules: true
- name: Install hugo
env:
HUGO_VER : 0.124.0
run: |
curl -LO https://github.com/gohugoio/hugo/releases/download/v${HUGO_VER}/hugo_${HUGO_VER}_linux-amd64.deb
sudo dpkg -i hugo_${HUGO_VER}_linux-amd64.deb
- name: Make docs
run: |
hugo -s ./docs/docs-gen
- name: Deploy docs
# Only deploy docs if this was a push to master
if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}
uses: JamesIves/[email protected]
with:
branch: gh-pages # The branch the action should deploy to.
folder: docs # The folder the action should deploy.
commit-message: Auto-deploy docs built from commit ${{ github.sha }}