⚒ Fix release docs javadocs actions (#6089)

SkriptLang · Jun 22, 2024 · 975b952 · 975b952
1 parent 4e8e8e6
commit 975b952
Show file tree

Hide file tree

Showing 4 changed files with 52 additions and 52 deletions.
diff --git a/.github/workflows/archive-docs.yml b/.github/workflows/archive-docs.yml
@@ -0,0 +1,46 @@
+name: Archive documentation
+
+on:
+  release:
+    types: [published]
+  workflow_dispatch:
+
+jobs:
+  archive-docs:
+      if: "! contains(toJSON(github.event.commits.*.message), '[ci skip]')"
+      needs: release-docs
+      runs-on: ubuntu-latest
+      steps:
+          - name: Configure workflow
+            id: configuration
+            run: |
+              echo "BRANCH_NAME=${GITHUB_REF#refs/*/}" >> $GITHUB_OUTPUT
+              echo "DOCS_OUTPUT_DIR=${GITHUB_WORKSPACE}/skript-docs/docs/archives/${GITHUB_REF#refs/tags/}" >> $GITHUB_OUTPUT
+              echo "DOCS_REPO_DIR=${GITHUB_WORKSPACE}/skript-docs" >> $GITHUB_OUTPUT
+              echo "SKRIPT_REPO_DIR=${GITHUB_WORKSPACE}/skript" >> $GITHUB_OUTPUT
+          - name: Checkout Skript
+            uses: actions/checkout@v4
+            with:
+                submodules: recursive
+                path: skript
+          - name: Setup documentation environment
+            uses: ./skript/.github/workflows/docs/setup-docs
+            with:
+                docs_deploy_key: ${{ secrets.DOCS_DEPLOY_KEY }}
+                docs_output_dir: ${{ steps.configuration.outputs.DOCS_OUTPUT_DIR }}
+          - name: Generate documentation
+            uses: ./skript/.github/workflows/docs/generate-docs
+            with:
+                docs_output_dir: ${{ steps.configuration.outputs.DOCS_OUTPUT_DIR }}
+                docs_repo_dir: ${{ steps.configuration.outputs.DOCS_REPO_DIR }}
+                docs_output_dir: ${{ steps.configuration.outputs.DOCS_OUTPUT_DIR }}
+                skript_repo_dir: ${{ steps.configuration.outputs.SKRIPT_REPO_DIR }}
+                is_release: true
+                generate_javadocs: true
+          - name: Push archive documentation
+            uses: ./skript/.github/workflows/docs/push-docs
+            with:
+                docs_repo_dir: ${{ steps.configuration.outputs.DOCS_REPO_DIR }}
+                git_name: Archive Docs Bot
+                git_email: archivedocs@skriptlang.org
+                git_commit_message: "Update ${{ steps.configuration.outputs.BRANCH_NAME }} archive docs"
diff --git a/.github/workflows/docs/generate-docs/action.yml b/.github/workflows/docs/generate-docs/action.yml
@@ -69,15 +69,15 @@ runs:
                   
         cd $SKRIPT_REPO_DIR
         if [[ "${IS_RELEASE}" == "true" ]]; then
-          ./gradlew genReleaseDocs releaseJavadoc
+          ./gradlew genReleaseDocs javadoc
         elif [[ "${GENERATE_JAVADOCS}" == "true" ]]; then
           ./gradlew genNightlyDocs javadoc
         else
           ./gradlew genNightlyDocs
         fi
 
         if [ -d "${DOCS_OUTPUT_DIR}" ]; then
-          if [[ "${GENERATE_JAVADOCS}" == "true" ]]; then
+          if [[ "${GENERATE_JAVADOCS}" == "true" ]] || [[ "${IS_RELEASE}" == "true" ]] ; then
               mkdir -p "${SKRIPT_DOCS_OUTPUT_DIR}/javadocs" && cp -a "./build/docs/javadoc/." "$_"
           fi
   

diff --git a/.github/workflows/release-docs.yml b/.github/workflows/release-docs.yml
@@ -3,6 +3,7 @@ name: Release documentation
 on:
   release:
     types: [published]
+  workflow_dispatch:
 
 jobs:
   release-docs:
@@ -33,6 +34,7 @@ jobs:
               docs_repo_dir: ${{ steps.configuration.outputs.DOCS_REPO_DIR }}
               skript_repo_dir: ${{ steps.configuration.outputs.SKRIPT_REPO_DIR }}
               is_release: true
+              generate_javadocs: true
               cleanup_pattern: "!(nightly|archives|templates)"
         - name: Push release documentation
           uses: ./skript/.github/workflows/docs/push-docs
@@ -41,40 +43,3 @@ jobs:
               git_name: Release Docs Bot
               git_email: releasedocs@skriptlang.org
               git_commit_message: "Update release docs to ${{ steps.configuration.outputs.BRANCH_NAME }}"
-
-  archive-docs:
-      if: "! contains(toJSON(github.event.commits.*.message), '[ci skip]')"
-      needs: release-docs
-      runs-on: ubuntu-latest
-      steps:
-          - name: Configure workflow
-            id: configuration
-            run: |
-              echo "BRANCH_NAME=${GITHUB_REF#refs/*/}" >> $GITHUB_OUTPUT
-              echo "DOCS_OUTPUT_DIR=${GITHUB_WORKSPACE}/skript-docs/docs/archives/${GITHUB_REF#refs/tags/}" >> $GITHUB_OUTPUT
-              echo "DOCS_REPO_DIR=${GITHUB_WORKSPACE}/skript-docs" >> $GITHUB_OUTPUT
-              echo "SKRIPT_REPO_DIR=${GITHUB_WORKSPACE}/skript" >> $GITHUB_OUTPUT
-          - name: Checkout Skript
-            uses: actions/checkout@v4
-            with:
-                submodules: recursive
-                path: skript
-          - name: Setup documentation environment
-            uses: ./skript/.github/workflows/docs/setup-docs
-            with:
-                docs_deploy_key: ${{ secrets.DOCS_DEPLOY_KEY }}
-                docs_output_dir: ${{ steps.configuration.outputs.DOCS_OUTPUT_DIR }}
-          - name: Generate documentation
-            uses: ./skript/.github/workflows/docs/generate-docs
-            with:
-                docs_repo_dir: ${{ steps.configuration.outputs.DOCS_REPO_DIR }}
-                docs_output_dir: ${{ steps.configuration.outputs.DOCS_OUTPUT_DIR }}
-                skript_repo_dir: ${{ steps.configuration.outputs.SKRIPT_REPO_DIR }}
-                is_release: true
-          - name: Push archive documentation
-            uses: ./skript/.github/workflows/docs/push-docs
-            with:
-                docs_repo_dir: ${{ steps.configuration.outputs.DOCS_REPO_DIR }}
-                git_name: Archive Docs Bot
-                git_email: archivedocs@skriptlang.org
-                git_commit_message: "Update ${{ steps.configuration.outputs.BRANCH_NAME }} archive docs"
diff --git a/build.gradle b/build.gradle
@@ -140,15 +140,6 @@ publishing {
 	}
 }
 
-task releaseJavadoc(type: Javadoc) {
-	title = project.name + ' ' + project.property('version')
-	source = sourceSets.main.allJava
-	classpath = configurations.compileClasspath
-	options.encoding = 'UTF-8'
-	// currently our javadoc has a lot of errors, so we need to suppress the linter
-	options.addStringOption('Xdoclint:none', '-quiet')
-}
-
 // Task to check that test scripts are named correctly
 tasks.register('testNaming') {
 	doLast {
@@ -367,7 +358,7 @@ task nightlyResources(type: ProcessResources) {
 			'today'           : '' + LocalTime.now(),
 			'release-flavor'  : 'skriptlang-nightly', // SkriptLang build, automatically done by CI
 			'release-channel' : 'prerelease', // No update checking, but these are VERY unstable
-			'release-updater' : 'ch.njol.skript.update.NoUpdateChecker', // No autoupdates for now
+			'release-updater' : 'ch.njol.skript.update.NoUpdateChecker', // No auto updates for now
 			'release-source'  : '',
 			'release-download': 'null'
 		]
@@ -389,8 +380,7 @@ task nightlyRelease(type: ShadowJar) {
 }
 
 javadoc {
-	dependsOn nightlyResources
-
+	title = 'Skript ' + project.property('version')
 	source = sourceSets.main.allJava
 
 	exclude("ch/njol/skript/conditions/**")
@@ -409,4 +399,3 @@ javadoc {
 	// currently our javadoc has a lot of errors, so we need to suppress the linter
 	options.addStringOption('Xdoclint:none', '-quiet')
 }
-