Merge pull request #3190 from Multiverse/fix/javadoc-action

Fix gha javadoc cp path
2026-11-05 00:50:10 -05:00 · 2025-04-08 21:10:40 +08:00 · 2025-04-08 21:05:38 +08:00 · 2025-04-08 20:48:13 +08:00 · 2025-04-02 20:35:49 +08:00 · 2025-04-02 16:44:55 +08:00
5 changed files with 120 additions and 24 deletions
@@ -0,0 +1,55 @@
+name: 'Dispatch: Deploy Javadoc'
+
+on:
+  workflow_dispatch:
+    inputs:
+      target_tag:
+        description: 'Version to generate javadoc'
+        required: true
+      replace_latest:
+        description: 'Replace the latest folder'
+        type: boolean
+
+jobs:
+  javadocs:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          ref: ${{ inputs.target_tag }}
+
+      - uses: actions/setup-java@v4
+        with:
+          java-version: '11'
+          distribution: 'adopt'
+          cache: gradle
+
+      - name: Setup Gradle
+        uses: gradle/actions/setup-gradle@v4
+
+      - name: build javadoc
+        run: ./gradlew javadoc
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          GITHUB_VERSION: ${{ inputs.target_tag }}
+
+      - name: Copy javadoc to deploy folder
+        run: |
+          mkdir -p build/docs/javadoc-deploy/${{ inputs.target_tag }}
+          cp -r build/docs/javadoc/* build/docs/javadoc-deploy/${{ inputs.target_tag }}
+
+      - name: Copy javadoc to latest folder
+        if: inputs.replace_latest
+        run: |
+          mkdir -p build/docs/javadoc-deploy/latest
+          cp -r build/docs/javadoc/* build/docs/javadoc-deploy/latest
+
+      - name: Deploy javadoc to gh pages
+        uses: JamesIves/github-pages-deploy-action@v4
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          folder: build/docs/javadoc-deploy
+          branch: javadoc
+          target-folder: javadoc
+          clean: false
+          commit-message: Deploy javadoc for ${{ inputs.target_tag }}
@@ -43,23 +43,21 @@ jobs:
          echo "version_bump: ${{ inputs.version_bump }}"
          echo "promote_from: ${{ inputs.promote_from }}"

-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
        with:
          ref: ${{ inputs.promote_from }}

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

-      - name: Validate Gradle wrapper
-        uses: gradle/wrapper-validation-action@v1
+      - name: Setup Gradle
+        uses: gradle/actions/setup-gradle@v4

      - name: Build and test
-        uses: gradle/gradle-build-action@v2
-        with:
-          arguments: clean build -x assemble -x shadowJar
+        run: ./gradlew clean build -x assemble -x shadowJar
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

@@ -74,9 +72,10 @@ jobs:

      - name: Publish package
        if: steps.release.outputs.release_created == 'true'
-        uses: gradle/gradle-build-action@v2
-        with:
-          arguments: publish -x test
+        run: >
+          ./gradlew publish -x test
+          -PmultiverseUsername=${{ secrets.REPOSILITE_REPO_USERNAME }}
+          -PmultiversePassword=${{ secrets.REPOSILITE_REPO_PASSWORD }}
        env:
          GITHUB_VERSION: ${{ steps.release.outputs.publish_version }}
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
@@ -89,3 +88,30 @@ 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'
+        run: ./gradlew javadoc
+        env:
+          GITHUB_VERSION: ${{ steps.release.outputs.publish_version }}
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Copy javadoc to version and latest folder
+        if: steps.javadoc.outcome == 'success'
+        run: |
+          mkdir -p build/docs/javadoc-deploy/latest
+          mkdir -p build/docs/javadoc-deploy/${{ steps.release.outputs.tag_name }}
+          cp -r build/docs/javadoc/* build/docs/javadoc-deploy/latest
+          cp -r build/docs/javadoc/* build/docs/javadoc-deploy/${{ steps.release.outputs.tag_name }}
+
+      - 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-deploy
+          branch: javadoc
+          target-folder: javadoc
+          clean: false
+          commit-message: Deploy javadoc for ${{ steps.release.outputs.tag_name }}
@@ -9,32 +9,40 @@ on:
        type: string

 jobs:
-  test:
+  test-and-artifact:
    runs-on: ubuntu-latest
    permissions:
      contents: read
    steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4

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

-      - name: Validate Gradle wrapper
-        uses: gradle/wrapper-validation-action@v1
+      - name: Setup Gradle
+        uses: gradle/actions/setup-gradle@v4

      - name: Run unit tests
-        uses: gradle/gradle-build-action@v2
-        with:
-          arguments: build
+        run: ./gradlew build
        env:
          GITHUB_VERSION: pr${{ github.event.pull_request.number }}
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

      - name: Artifact output
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
        with:
          name: ${{ inputs.plugin_name }}-pr${{ github.event.pull_request.number }}
          path: build/libs/${{ inputs.plugin_name }}-pr${{ github.event.pull_request.number }}.jar
+
+  comment-artifact:
+    needs: test-and-artifact
+    runs-on: ubuntu-latest
+    permissions:
+      pull-requests: write
+    steps:
+      - uses: benwoo1110/artifact-comment-action@v1
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
@@ -3,12 +3,12 @@
 </p>

 [![Modrinth](https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/cozy/available/modrinth_vector.svg)](https://modrinth.com/plugin/multiverse-core)
-[![hangar](https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/cozy/available/hangar_vector.svg)](https://hangar.papermc.io/Multiverse/Multiverse-Core)
-[![bukkit](https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/cozy/supported/bukkit_vector.svg)](https://dev.bukkit.org/projects/multiverse-core)
-[![Spigot](https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/cozy/supported/spigot_vector.svg)](https://www.spigotmc.org/resources/multiverse-core.390/)
+[![Hangar](https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/cozy/available/hangar_vector.svg)](https://hangar.papermc.io/Multiverse/Multiverse-Core)
+[![Bukkit](https://raw.githubusercontent.com/intergrav/devins-badges/refs/heads/v3/assets/cozy/available/bukkit_vector.svg)](https://dev.bukkit.org/projects/multiverse-core)
+[![Spigot](https://raw.githubusercontent.com/intergrav/devins-badges/refs/heads/v3/assets/cozy/available/spigot_vector.svg)](https://www.spigotmc.org/resources/multiverse-core.390/)

-[![Release](https://img.shields.io/nexus/r/com.onarandombox.multiversecore/multiverse-core?server=https%3A%2F%2Frepo.onarandombox.com&label=release&color=dark-green)](https://dev.bukkit.org/projects/multiverse-core)
-[![Dev builds](https://img.shields.io/nexus/s/com.onarandombox.multiversecore/multiverse-core?server=https%3A%2F%2Frepo.onarandombox.com&label=prerelease&color=orange)](https://ci.onarandombox.com/job/Multiverse-Core/)
+[![Release](https://img.shields.io/github/v/release/multiverse/multiverse-core)](https://github.com/Multiverse/Multiverse-Core/releases/latest)
+[![Pre-Release](https://img.shields.io/github/v/release/multiverse/multiverse-core?include_prereleases&label=Pre-release)](https://github.com/Multiverse/Multiverse-Core/releases)
 [![Discord](https://img.shields.io/discord/325459248047980545?label=discord&logo=discord)](https://discord.gg/NZtfKky)
 [![Support us on Patreon](https://img.shields.io/badge/donate-patreon-white?logo=patreon)](https://patreon.com/dumptruckman)
 [![License](https://img.shields.io/github/license/Multiverse/Multiverse-Core?color=blue)](LICENSE.md)
@@ -126,6 +126,13 @@ publishing {
                password = System.getenv("GITHUB_TOKEN")
            }
        }
+        maven {
+            name = "multiverse"
+            def releasesRepoUrl = "https://repo.onarandombox.com/multiverse-releases"
+            def snapshotsRepoUrl = "https://repo.onarandombox.com/multiverse-snapshots"
+            url = version.endsWith('SNAPSHOT') ? snapshotsRepoUrl : releasesRepoUrl
+            credentials(PasswordCredentials)
+        }
    }
 }
Author	SHA1	Message	Date
Ben Woo	9317f4cd6b	Merge pull request #3190 from Multiverse/fix/javadoc-action Fix gha javadoc cp path	2025-04-08 21:10:40 +08:00
Ben Woo	00b4a9bab4	Fix gha javadoc cp path	2025-04-08 21:05:38 +08:00
Ben Woo	48a091842a	Merge pull request #3188 from Multiverse/ben/fix-gha-publish	2025-04-08 20:48:13 +08:00
Ben Woo	c541c27485	Fix gha gradle publish command	2025-04-02 20:35:49 +08:00
Ben Woo	fd02e00da6	Merge pull request #3187 from Multiverse/ben/publish-repo	2025-04-02 16:44:55 +08:00
Ben Woo	e14853dc11	Use onarandombox repo for publishing	2025-03-29 17:46:15 +08:00
Ben Woo	9e25e1d00b	Merge pull request #3176 from Multiverse/ben/update-gradle-action Update gradle gha deps to v4	2025-02-28 22:30:19 +08:00
Ben Woo	f966266bdc	Merge pull request #3177 from Multiverse/zax71/main/updated-readme	2025-02-24 11:58:24 +08:00
Zax71	c5b4b88647	Change available for to available on in badges and fix release/pre-release badges	2025-02-23 09:21:46 +00:00
Ben Woo	e3409be81b	Update gradle gha deps to v4	2025-02-22 13:16:43 +08:00
Ben Woo	5b3477af3e	Merge pull request #3117 from Multiverse/ben/pr-comment-artifact Comment build artifact in PR	2024-11-21 21:36:51 +08:00
Ben Woo	2f8d23390a	Merge pull request #3128 from Multiverse/fix-publish-repo	2024-11-19 07:08:32 +08:00
Jeremy Wood	c4d01b65b7	Publish to correct repo url based on version.	2024-11-18 15:36:47 -05:00
Jeremy Wood	e33fc93a1d	Merge pull request #3126 from Multiverse/ben/fix-publish Fix gha publish command	2024-11-16 02:29:27 -05:00
Ben Woo	656b318be3	Fix gha publish command	2024-11-16 15:27:32 +08:00
Jeremy Wood	562dece6f9	Merge pull request #3125 from Multiverse/jwood/reposilite Publish to new repo using temp url.	2024-11-16 02:02:19 -05:00
Jeremy Wood	fa30b432a9	Publish to new repo using temp url.	2024-11-15 23:19:53 -05:00
Jeremy Wood	83b6236ed7	Merge pull request #3124 from Multiverse/ben/javadoc-latest Add latest dir for javadoc	2024-11-14 00:51:18 -05:00
Ben Woo	41cab5b290	Improve replace_latest description	2024-11-14 13:40:53 +08:00
Ben Woo	99a716ccaa	latest boolean	2024-11-14 13:38:42 +08:00
Ben Woo	ecca904aef	Add latest dir for javadoc	2024-11-14 13:26:32 +08:00
Ben Woo	a2a740f371	Merge pull request #3123 from Multiverse/ben/javadoc Javadoc with github action	2024-11-14 12:32:51 +08:00
Ben Woo	c66b1a2b96	Add manual dispatch action for javadoc	2024-11-14 12:25:13 +08:00
Ben Woo	52b2170f8f	Deploy javadoc to github pages on release	2024-11-14 12:22:30 +08:00
Ben Woo	17d376d4d4	Bump upload artifact action to v4	2024-10-13 10:54:38 +08:00
Ben Woo	1547ea84c6	Comment build artifact in PR	2024-10-13 10:54:19 +08:00