generate-documentation.yml

# This workflow will do a clean installation of node dependencies, cache/restore them, build the source code and run tests across different versions of node
# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-nodejs

name: Node.js CI

on:
  push:
    branches: ['master']

jobs:
  build:
    runs-on: ubuntu-latest

    strategy:
      matrix:
        node-version: ['18.x']

    steps:
      - name: Checkout master branch
        uses: actions/checkout@v4
        with:
          ref: master
      - name: Use Node.js ${{ matrix.node-version }}
        uses: actions/setup-node@v3
        with:
          node-version: ${{ matrix.node-version }}
          cache: 'npm'
      # generate the documentation
      - run: npm install
      - run: npm run docs
      # commit and push the changes on the docs branch
      - name: Commit docs changes
        run: |
          git checkout -b docs
          git config --global user.name 'VCity Github Action'
          git config --global user.email 'vcity@liris.cnrs.fr'
          git add .
          git commit -m "Documentation update"
          git push --set-upstream origin docs --force