Merge pull request #122 from nsc-de/dependabot/npm_and_yarn/typedoc-0… #603
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
# Build and Deploy TypeDoc to GitHub Pages | |
name: "Deploy Documentation 📚" | |
on: | |
# Runs on pushes targeting the default branch | |
push: | |
branches: ["master"] | |
# 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, skipping runs queued between the run in-progress and latest queued. | |
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete. | |
concurrency: | |
group: "pages" | |
cancel-in-progress: false | |
jobs: | |
# Single deploy job since we're just deploying | |
deploy: | |
environment: | |
name: github-pages | |
url: ${{ steps.deployment.outputs.page_url }} | |
runs-on: ubuntu-latest | |
# # To use Remote Caching, uncomment the next lines and follow the steps below. | |
# env: | |
# TURBO_TOKEN: ${{ secrets.TURBO_TOKEN }} | |
# TURBO_TEAM: ${{ vars.TURBO_TEAM }} | |
# TURBO_REMOTE_ONLY: true | |
steps: | |
- name: Checkout 🛎️ | |
uses: actions/checkout@v2.3.1 | |
with: | |
persist-credentials: false | |
- name: Cache ♻️ | |
id: cache-npm | |
uses: actions/cache@v3 | |
env: | |
cache-name: cache-node-modules | |
with: | |
# npm cache files are stored in `~/.npm` on Linux/macOS | |
path: ~/.npm | |
key: ${{ runner.os }}-build-${{ env.cache-name }}-${{ hashFiles('**/package-lock.json') }} | |
restore-keys: | | |
${{ runner.os }}-build-${{ env.cache-name }}- | |
${{ runner.os }}-build- | |
${{ runner.os }}- | |
- if: ${{ steps.cache-npm.outputs.cache-hit != 'true' }} | |
name: List the state of node modules 📃 | |
continue-on-error: true | |
run: npm list | |
- name: Install ⤵️ | |
run: | | |
npm ci | |
npm ci --prefix docs | |
# - name: Cache Turbo ♻️ | |
# uses: dtinth/setup-github-actions-caching-for-turbo@v1 | |
# with: | |
# cache-prefix: turbo-docs-${{github.ref}}_ | |
- name: Build 🔧 | |
run: npm run docs | |
- name: Setup Pages 📄 | |
uses: actions/configure-pages@v3 | |
- name: Upload artifact ☁️ | |
uses: actions/upload-pages-artifact@v2 | |
with: | |
# Upload entire repository | |
path: "./docs/build" | |
- name: Deploy to GitHub Pages 🚀 | |
id: deployment | |
uses: actions/deploy-pages@v2 |