Documentation #560
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: Documentation | |
| on: [push, workflow_dispatch] | |
| concurrency: | |
| group: ${{ github.workflow }}-${{ github.ref }} | |
| cancel-in-progress: true | |
| env: | |
| BASE_PATH: allwpilib/docs | |
| jobs: | |
| publish: | |
| name: "Documentation - Publish" | |
| runs-on: ubuntu-22.04 | |
| if: github.repository_owner == 'wpilibsuite' && (github.ref == 'refs/heads/main' || startsWith(github.ref, 'refs/tags/v')) | |
| concurrency: ci-docs-publish | |
| steps: | |
| - uses: actions/checkout@v3 | |
| with: | |
| fetch-depth: 0 | |
| persist-credentials: false | |
| - uses: actions/setup-java@v3 | |
| with: | |
| distribution: 'zulu' | |
| java-version: 13 | |
| - name: Set environment variables (Development) | |
| run: | | |
| echo "TARGET_FOLDER=$BASE_PATH/development" >> $GITHUB_ENV | |
| if: github.ref == 'refs/heads/main' | |
| - name: Set environment variables (Tag) | |
| run: | | |
| echo "EXTRA_GRADLE_ARGS=-PreleaseMode" >> $GITHUB_ENV | |
| echo "TARGET_FOLDER=$BASE_PATH/beta" >> $GITHUB_ENV | |
| if: startsWith(github.ref, 'refs/tags/v') | |
| - name: Set environment variables (Release) | |
| run: | | |
| echo "EXTRA_GRADLE_ARGS=-PreleaseMode" >> $GITHUB_ENV | |
| echo "TARGET_FOLDER=$BASE_PATH/release" >> $GITHUB_ENV | |
| if: startsWith(github.ref, 'refs/tags/v') && !contains(github.ref, 'alpha') && !contains(github.ref, 'beta') | |
| - name: Build with Gradle | |
| run: ./gradlew docs:generateJavaDocs docs:doxygen -PbuildServer ${{ env.EXTRA_GRADLE_ARGS }} | |
| - name: Install SSH Client 🔑 | |
| uses: webfactory/[email protected] | |
| with: | |
| ssh-private-key: ${{ secrets.GH_DEPLOY_KEY }} | |
| - name: Deploy Java 🚀 | |
| uses: JamesIves/[email protected] | |
| with: | |
| SSH: true | |
| REPOSITORY_NAME: wpilibsuite/wpilibsuite.github.io | |
| BRANCH: main | |
| CLEAN: true | |
| FOLDER: docs/build/docs/javadoc | |
| TARGET_FOLDER: ${{ env.TARGET_FOLDER }}/java | |
| - name: Deploy C++ 🚀 | |
| uses: JamesIves/[email protected] | |
| with: | |
| SSH: true | |
| REPOSITORY_NAME: wpilibsuite/wpilibsuite.github.io | |
| BRANCH: main | |
| CLEAN: true | |
| FOLDER: docs/build/docs/doxygen/html | |
| TARGET_FOLDER: ${{ env.TARGET_FOLDER }}/cpp |