mirror of
https://github.com/wpilibsuite/allwpilib
synced 2026-06-19 00:41:43 +00:00
65 lines
2.3 KiB
YAML
65 lines
2.3 KiB
YAML
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/ssh-agent@v0.8.0
|
|
with:
|
|
ssh-private-key: ${{ secrets.GH_DEPLOY_KEY }}
|
|
- name: Deploy Java 🚀
|
|
uses: JamesIves/github-pages-deploy-action@v4.4.1
|
|
with:
|
|
ssh-key: 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/github-pages-deploy-action@v4.4.1
|
|
with:
|
|
ssh-key: true
|
|
repository-name: wpilibsuite/wpilibsuite.github.io
|
|
branch: main
|
|
clean: true
|
|
folder: docs/build/docs/doxygen/html
|
|
target-folder: ${{ env.TARGET_FOLDER }}/cpp
|