Merge pull request #1573 from qdraw/feature/auto_documentation_create… #322
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
# Simple workflow for deploying static content to GitHub Pages | |
name: Documentation to github pages | |
on: | |
# Runs on pushes targeting the default branch | |
push: | |
branches: ["master"] | |
paths: | |
- documentation/** | |
# 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 one concurrent deployment | |
concurrency: | |
group: "pages" | |
cancel-in-progress: true | |
jobs: | |
# Single deploy job since we're just deploying | |
deploy: | |
environment: | |
name: github-pages | |
url: ${{ steps.deployment.outputs.page_url }} | |
runs-on: ubuntu-latest | |
steps: | |
- name: Checkout | |
uses: actions/checkout@v4 | |
- name: Cache node modules clientapp | |
uses: actions/cache@v4 | |
with: | |
# npm cache files are stored in `~/.npm` on Linux/macOS | |
path: ~/.npm | |
key: ${{ runner.os }}-documentation-${{ hashFiles('./documentation/package-lock.json') }} | |
restore-keys: | | |
${{ runner.os }}-documentation- | |
- name: Install Dependencies | |
working-directory: ./documentation | |
run: npm ci --no-progress --prefer-offline --legacy-peer-deps --no-fund | |
- name: NpmBuild | |
working-directory: ./documentation | |
run: | | |
export DOCS_URL="https://docs.qdraw.nl" | |
export DOCS_BASE_URL="/starsky" | |
npm run build | |
- name: Setup Pages | |
uses: actions/configure-pages@v5 | |
- name: Upload artifact | |
uses: actions/upload-pages-artifact@v3 | |
with: | |
# Upload entire repository | |
path: 'documentation/build' | |
- name: Deploy to GitHub Pages | |
id: deployment | |
uses: actions/deploy-pages@v4 |