Skip to content

Merge pull request #955 from digital-land/fix-production-urls #12

Merge pull request #955 from digital-land/fix-production-urls

Merge pull request #955 from digital-land/fix-production-urls #12

Workflow file for this run

name: Deploy Documentation to GitHub Pages
on:
# Runs on pushes targeting the default branch
push:
branches: ["main"]
# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
contents: read
pages: write
id-token: write
# Allow only one concurrent deployment
concurrency:
group: "pages"
cancel-in-progress: true
jobs:
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Setup Node.js
uses: actions/setup-node@v4
with:
node-version: '20'
cache: 'npm'
- name: Install dependencies
run: npm ci
- name: Generate documentation
run: npm run generate:docs
- name: Validate documentation output
run: |
if [ ! -d "./github-pages" ] || [ -z "$(ls -A ./github-pages)" ]; then
echo "Documentation directory is empty or does not exist!"
exit 1
fi
echo "Documentation successfully generated"
- name: Setup Pages
uses: actions/configure-pages@v4
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: './github-pages'
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4