build Docs #548
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: build Docs | |
| on: | |
| pull_request: | |
| branches: [master] | |
| paths: | |
| - "*.h" | |
| - "docs/**" | |
| - "!docs/README.md" | |
| - "*.md" | |
| - "utility/template/*.h" | |
| - "examples**.cpp" | |
| - "examples**.ino" | |
| - "images/**" | |
| - "datasheets/**" | |
| - ".github/workflows/doxygen.yml" | |
| - "Doxyfile" | |
| - "library.properties" # get lib version from here | |
| push: | |
| branches: [master] | |
| paths: | |
| - "*.h" | |
| - "docs/**" | |
| - "!docs/README.md" | |
| - "*.md" | |
| - "utility/template/*.h" | |
| - "examples**.cpp" | |
| - "examples**.ino" | |
| - "images/**" | |
| - "datasheets/**" | |
| - ".github/workflows/doxygen.yml" | |
| - "Doxyfile" | |
| - "library.properties" # get lib version from here | |
| release: | |
| types: [published, edited] | |
| workflow_dispatch: | |
| jobs: | |
| check-spelling: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/setup-node@v4 | |
| with: | |
| node-version: 20.x | |
| - uses: actions/checkout@v4 | |
| - name: Install cSpell | |
| run: npm install -g cspell | |
| - run: npx cspell --gitignore --config cspell.config.yaml . | |
| build-docs: | |
| uses: nRF24/.github/.github/workflows/build_docs.yaml@main | |
| with: | |
| deploy-gh-pages: ${{ github.event_name == 'release' || (github.event_name == 'workflow_dispatch' && github.ref == 'refs/heads/master') }} | |
| doxygen-version: '1.12.0' | |
| secrets: inherit |