From 22496b0e239a9742ebd2aa43b8b34e8a1d61a00d Mon Sep 17 00:00:00 2001 From: pbronka <56582427+pbronka@users.noreply.github.com> Date: Tue, 12 Aug 2025 18:10:54 +0100 Subject: [PATCH] Create publish-javadoc.yml Create workflow for automatic documentation creation and deployment on push to develop branch --- .github/workflows/publish-javadoc.yml | 38 +++++++++++++++++++++++++++ 1 file changed, 38 insertions(+) create mode 100644 .github/workflows/publish-javadoc.yml diff --git a/.github/workflows/publish-javadoc.yml b/.github/workflows/publish-javadoc.yml new file mode 100644 index 000000000..ca559d589 --- /dev/null +++ b/.github/workflows/publish-javadoc.yml @@ -0,0 +1,38 @@ +name: Publish Javadoc + +on: + push: + branches: + - develop # Only publish when pushing to develop branch + +jobs: + publish-javadoc: + runs-on: ubuntu-latest + permissions: + contents: write # Needed to push to the javadoc branch + + steps: + - name: Checkout repository + uses: actions/checkout@v3 + + - name: Set up JDK 19 + uses: actions/setup-java@v3 + with: + java-version: '19' + distribution: 'temurin' + cache: maven + + - name: Build (optional if Javadoc needs compiled sources) + run: mvn -B compile --file pom.xml + + - name: Generate Javadoc + run: mvn javadoc:javadoc --file pom.xml + + - name: Deploy Javadoc to branch + uses: MathieuSoysal/Javadoc-publisher.yml@v3.0.2 + with: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + javadoc-branch: javadoc # Branch to store Javadoc + java-version: 19 + target-folder: target/site/apidocs # Javadoc output directory + project: maven