docs.yml

 1name: Generate Docs
 2
 3permissions:
 4  contents: write
 5
 6on:
 7  push:
 8    branches:
 9    - master
10    paths:
11    - 'builddefs/docsgen/**'
12    - 'tmk_core/**'
13    - 'quantum/**'
14    - 'platforms/**'
15    - 'docs/**'
16    - '.github/workflows/docs.yml'
17  pull_request:
18    paths:
19    - 'builddefs/docsgen/**'
20    - 'docs/**'
21    - '.github/workflows/docs.yml'
22
23defaults:
24  run:
25    shell: bash
26
27jobs:
28  generate:
29    runs-on: ubuntu-latest
30    container: ghcr.io/qmk/qmk_cli
31
32    steps:
33    - uses: actions/checkout@v4
34      with:
35        fetch-depth: 1
36
37    - name: Install dependencies
38      run: |
39        apt-get update && apt-get install -y rsync doxygen
40        # install nvm
41        touch $HOME/.bashrc
42        wget -qO- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.7/install.sh | bash
43
44    - name: Install node
45      run: |
46        source $HOME/.bashrc
47        nvm install 20
48        nvm use 20
49        corepack enable
50
51    - name: Build docs
52      run: |
53        source $HOME/.bashrc
54        nvm use 20
55        qmk --verbose generate-docs
56
57    - name: Deploy
58      if: ${{ github.event_name == 'push' && github.repository == 'qmk/qmk_firmware' }}
59      uses: JamesIves/github-pages-deploy-action@v4.7.2
60      with:
61          token: ${{ secrets.GITHUB_TOKEN }}
62          branch: gh-pages
63          folder: .build/docs
64          git-config-name: QMK Bot
65          git-config-email: hello@qmk.fm