Add GitHub Actions workflows for build, documentation, and release pr… #1
This file contains hidden or 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: Documentation | |
| on: | |
| push: | |
| branches: [ main ] | |
| paths: | |
| - 'README.md' | |
| - 'docs/**' | |
| - '.github/workflows/documentation.yml' | |
| pull_request: | |
| branches: [ main ] | |
| paths: | |
| - 'README.md' | |
| - 'docs/**' | |
| jobs: | |
| validate-markdown: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Setup Node.js | |
| uses: actions/setup-node@v4 | |
| with: | |
| node-version: '18' | |
| - name: Install markdown-lint | |
| run: npm install -g markdownlint-cli | |
| - name: Validate markdown files | |
| run: | | |
| markdownlint-cli README.md others/docs/*.md examples/*/docs/*.md || true | |
| - name: Check for broken links | |
| uses: gaurav-nelson/github-action-markdown-link-check@v1 | |
| with: | |
| use-recursive-processing: true | |
| use-quiet-mode: false | |
| build-docs: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Set up build environment | |
| run: | | |
| sudo apt-get update | |
| sudo apt-get install -y doxygen graphviz | |
| - name: Build documentation | |
| run: | | |
| cd examples/ImGui | |
| make docs | |
| continue-on-error: true | |
| - name: Upload docs artifact | |
| uses: actions/upload-artifact@v4 | |
| if: always() | |
| with: | |
| name: documentation | |
| path: examples/ImGui/build/docs/html/ | |
| retention-days: 30 |