Doc updates #233
Workflow file for this run
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: Docs | |
| on: | |
| push: | |
| branches: | |
| - master | |
| - 'Stable*' | |
| tags: | |
| - 'v*' | |
| paths: | |
| - 'docs/**' | |
| pull_request: | |
| paths: | |
| - 'docs/**' | |
| workflow_dispatch: | |
| env: | |
| BRANCH_NAME: ${{ github.head_ref || github.ref_name }} | |
| jobs: | |
| build: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v4 | |
| - name: Setup Node | |
| uses: actions/setup-node@v4 | |
| with: | |
| node-version: 20 | |
| cache: npm | |
| - name: Install dependencies | |
| run: npm ci | |
| - name: Build with VitePress | |
| run: | | |
| npm run docs:build | |
| touch docs/.vitepress/dist/.nojekyll | |
| - name: Upload artifact | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: qgc_docs_build | |
| path: docs/.vitepress/dist/ | |
| retention-days: 1 | |
| deploy: | |
| if: ${{ github.event_name == 'push' || github.event_name == 'workflow_dispatch' || (github.event_name == 'pull_request' && github.event.pull_request.merged) }} | |
| needs: build | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Download Artifact | |
| uses: actions/download-artifact@v4 | |
| with: | |
| name: qgc_docs_build | |
| path: ~/_book | |
| - name: Deploy | |
| env: | |
| GIT_USER: ${{ secrets.PX4BUILDBOT_USER }} | |
| GIT_PASS: ${{ secrets.PX4BUILDBOT_PASS }} | |
| run: | | |
| git clone https://${{ secrets.PX4BUILDBOT_USER }}:${{ secrets.PX4BUILDBOT_ACCESSTOKEN }}@github.com/mavlink/docs.qgroundcontrol.com.git | |
| rm -rf docs.qgroundcontrol.com/${{ env.BRANCH_NAME }} | |
| mkdir -p docs.qgroundcontrol.com/${{ env.BRANCH_NAME }} | |
| cp -r ~/_book/* docs.qgroundcontrol.com/${{ env.BRANCH_NAME }}/ | |
| cd docs.qgroundcontrol.com | |
| git config user.email "[email protected]" | |
| git config user.name "PX4BuildBot" | |
| git add ${{ env.BRANCH_NAME }} | |
| git commit -a -m "QGC docs build update `date`" | |
| git push origin master |