[WIP] XAP -- eXtensible Application Protocol #1353
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
| name: Generate Docs | |
| permissions: | |
| contents: write | |
| on: | |
| push: | |
| branches: | |
| - master | |
| paths: | |
| - 'builddefs/docsgen/**' | |
| - 'tmk_core/**' | |
| - 'quantum/**' | |
| - 'platforms/**' | |
| - 'docs/**' | |
| - '.github/workflows/docs.yml' | |
| pull_request: | |
| paths: | |
| - 'builddefs/docsgen/**' | |
| - 'docs/**' | |
| - '.github/workflows/docs.yml' | |
| defaults: | |
| run: | |
| shell: bash | |
| jobs: | |
| generate: | |
| runs-on: ubuntu-latest | |
| container: ghcr.io/qmk/qmk_cli | |
| steps: | |
| - uses: actions/checkout@v4 | |
| with: | |
| fetch-depth: 1 | |
| - name: Install dependencies | |
| run: | | |
| pip3 install -r requirements-dev.txt | |
| apt-get update && apt-get install -y rsync doxygen | |
| # install nvm | |
| touch $HOME/.bashrc | |
| wget -qO- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.7/install.sh | bash | |
| - name: Install node | |
| run: | | |
| source $HOME/.bashrc | |
| nvm install 20 | |
| nvm use 20 | |
| corepack enable | |
| - name: Build docs | |
| run: | | |
| source $HOME/.bashrc | |
| nvm use 20 | |
| qmk --verbose generate-docs | |
| - name: Deploy | |
| if: ${{ github.event_name == 'push' && github.repository == 'qmk/qmk_firmware' }} | |
| uses: JamesIves/[email protected] | |
| with: | |
| token: ${{ secrets.GITHUB_TOKEN }} | |
| branch: gh-pages | |
| folder: .build/docs | |
| git-config-name: QMK Bot | |
| git-config-email: [email protected] |