Skip to content

Commit

Permalink
Merge pull request #3123 from Multiverse/ben/javadoc
Browse files Browse the repository at this point in the history
Javadoc with github action
  • Loading branch information
benwoo1110 authored Nov 14, 2024
2 parents 38f97a8 + c66b1a2 commit a2a740f
Show file tree
Hide file tree
Showing 2 changed files with 59 additions and 0 deletions.
39 changes: 39 additions & 0 deletions .github/workflows/dispatch.javadoc.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
name: 'Dispatch: Deploy Javadoc'

on:
workflow_dispatch:
inputs:
target_tag:
description: 'Version to generate javadoc'
required: true

jobs:
javadocs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
with:
ref: ${{ inputs.target_tag }}

- uses: actions/setup-java@v3
with:
java-version: '11'
distribution: 'adopt'
cache: gradle

- name: build javadoc
uses: gradle/gradle-build-action@v2
with:
arguments: javadoc
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
GITHUB_VERSION: ${{ inputs.target_tag }}

- name: Deploy javadoc to gh pages
uses: JamesIves/github-pages-deploy-action@v4
with:
token: ${{ secrets.GITHUB_TOKEN }}
folder: build/docs/javadoc
branch: javadoc
target-folder: javadoc/${{ inputs.target_tag }}
commit-message: Deploy javadoc for ${{ inputs.target_tag }}
20 changes: 20 additions & 0 deletions .github/workflows/generic.github_release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -89,3 +89,23 @@ jobs:
file: build/libs/${{ inputs.plugin_name }}-${{ steps.release.outputs.publish_version }}.jar
asset_name: ${{ inputs.plugin_name }}-${{ steps.release.outputs.tag_name }}.jar
tag: ${{ steps.release.outputs.tag_name }}

- name: Generate javadoc
id: javadoc
if: steps.release.outputs.release_created == 'true' && steps.release.outputs.release_type == 'release'
uses: gradle/gradle-build-action@v2
with:
arguments: javadoc
env:
GITHUB_VERSION: ${{ steps.release.outputs.publish_version }}
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

- name: Deploy javadoc to gh pages
if: steps.javadoc.outcome == 'success'
uses: JamesIves/github-pages-deploy-action@v4
with:
token: ${{ secrets.GITHUB_TOKEN }}
folder: build/docs/javadoc
branch: javadoc
target-folder: javadoc/${{ steps.release.outputs.tag_name }}
commit-message: Deploy javadoc for ${{ steps.release.outputs.tag_name }}

0 comments on commit a2a740f

Please sign in to comment.