mikro-orm/mikro-orm

View on GitHub
.github/workflows/docs.yml

Summary

Maintainability
Test Coverage
name: docs

on:
  push:
    branches:
      - master
  workflow_dispatch:

jobs:
  build:
    environment:
      name: github-pages
    permissions:
      contents: write
      pages: write
      id-token: write
    runs-on: ubuntu-latest

    steps:
    - uses: actions/checkout@v4
    - name: Use Node.js 20
      uses: actions/setup-node@v4
      with:
        node-version: 20
        token: ${{ secrets.GH_TOKEN }}

    - name: Enable corepack
      run: |
        corepack enable
        corepack prepare yarn@stable --activate

    # Yarn dependencies cannot be cached until yarn is installed
    # WORKAROUND: https://github.com/actions/setup-node/issues/531
    - name: Extract cached dependencies
      uses: actions/setup-node@v4
      with:
        cache: yarn

    - name: Install
      run: yarn

    - name: Set git identity
      run: |
        git config --global user.name "Martin Adámek"
        git config --global user.email "banan23@gmail.com"

    - name: Install
      run: |
        corepack prepare yarn@stable --activate
        yarn

    - name: Build docs
      run: |
        cd docs
        yarn
        yarn build

    - name: Set up GitHub Pages
      uses: actions/configure-pages@v5

    - name: Upload GitHub Pages artifact
      uses: actions/upload-pages-artifact@v3
      with:
        path: ./docs/build

    - name: Deploy artifact to GitHub Pages
      uses: actions/deploy-pages@v4