qmk_firmware

QMK firmware for my keyboards (Corne, Sweep Ferris) and trackball (Ploopy Adept)
Log | Files | Refs | Submodules | LICENSE

docs.yml (1390B)

      1 name: Generate Docs
      2 
      3 permissions:
      4   contents: write
      5 
      6 on:
      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 
     23 defaults:
     24   run:
     25     shell: bash
     26 
     27 jobs:
     28   generate:
     29     runs-on: ubuntu-latest
     30     container: ghcr.io/qmk/qmk_cli
     31 
     32     steps:
     33     - uses: actions/checkout@v6
     34       with:
     35         fetch-depth: 1
     36 
     37     - name: Install dependencies
     38       run: pip3 install -r requirements-dev.txt
     39 
     40     - name: Install nvm
     41       run: |
     42         touch $HOME/.bashrc
     43         wget -qO- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.7/install.sh | bash
     44 
     45     - name: Install node
     46       run: |
     47         source $HOME/.bashrc
     48         nvm install 20
     49         nvm use 20
     50         corepack enable
     51 
     52     - name: Build docs
     53       run: |
     54         source $HOME/.bashrc
     55         nvm use 20
     56         qmk --verbose generate-docs
     57 
     58     - name: Deploy
     59       if: ${{ github.event_name == 'push' && github.repository == 'qmk/qmk_firmware' }}
     60       uses: JamesIves/github-pages-deploy-action@v4.8.0
     61       with:
     62           token: ${{ secrets.GITHUB_TOKEN }}
     63           branch: gh-pages
     64           folder: .build/docs
     65           git-config-name: QMK Bot
     66           git-config-email: hello@qmk.fm