Update GitHub Actions, add Dokka publishing action (#139)

JetBrains-Research · Sep 11, 2023 · 356fb32 · 356fb32
1 parent 438a20b
commit 356fb32
Show file tree

Hide file tree

Showing 9 changed files with 64 additions and 9 deletions.
diff --git a/.github/workflows/detekt.yml b/.github/workflows/detekt.yml
@@ -10,13 +10,15 @@ jobs:
     runs-on: ubuntu-20.04
 
     steps:
-      - uses: actions/checkout@v3.5.2
+      - uses: actions/checkout@v3.6.0
       - name: Set up JDK 11
-        uses: actions/setup-java@v3.11.0
+        uses: actions/setup-java@v3.12.0
         with:
           java-version: 11
           distribution: liberica
-      - uses: gradle/gradle-build-action@v2.4.2
+      - name: Gradle Wrapper Validation
+        uses: gradle/wrapper-validation-action@v1.1.0
+      - uses: gradle/gradle-build-action@v2.7.1
         with:
           arguments: detekt --stacktrace
       - uses: github/codeql-action/upload-sarif@v2

diff --git a/.github/workflows/diktat.yml b/.github/workflows/diktat.yml
@@ -10,12 +10,14 @@ jobs:
     runs-on: ubuntu-20.04
 
     steps:
-      - uses: actions/checkout@v3.5.2
+      - uses: actions/checkout@v3.6.0
       - name: Set up JDK 11
-        uses: actions/setup-java@v3.11.0
+        uses: actions/setup-java@v3.12.0
         with:
           java-version: 11
           distribution: liberica
-      - uses: gradle/gradle-build-action@v2.4.2
+      - name: Gradle Wrapper Validation
+        uses: gradle/wrapper-validation-action@v1.1.0
+      - uses: gradle/gradle-build-action@v2.7.1
         with:
           arguments: diktatCheckAll -Ddiktat.githubActions=true --stacktrace
diff --git a/.github/workflows/gradle-build.yml b/.github/workflows/gradle-build.yml
@@ -7,14 +7,16 @@ jobs:
     runs-on: ubuntu-20.04
 
     steps:
-      - uses: actions/checkout@v3.5.2
+      - uses: actions/checkout@v3.6.0
       - name: Set up JDK 11
-        uses: actions/setup-java@v3.11.0
+        uses: actions/setup-java@v3.12.0
         with:
           java-version: 11
           distribution: liberica
+      - name: Gradle Wrapper Validation
+        uses: gradle/wrapper-validation-action@v1.1.0
       - name: Gradle Build
-        uses: gradle/gradle-build-action@v2.4.2
+        uses: gradle/gradle-build-action@v2.7.1
         with:
           arguments: build --stacktrace -x test
 #      - name: Gradle Test

diff --git a/.github/workflows/pages.yml b/.github/workflows/pages.yml
@@ -0,0 +1,25 @@
+name: Dokka publication
+
+on:
+  workflow_dispatch:
+  release:
+    types: [ created ]
+
+jobs:
+  build:
+    runs-on: ubuntu-20.04
+
+    steps:
+      - uses: actions/checkout@v3.6.0
+      - name: Set up JDK 11
+        uses: actions/setup-java@v3.12.0
+        with:
+          java-version: 11
+          distribution: liberica
+      - uses: gradle/gradle-build-action@v2.7.1
+        with:
+          arguments: dokkaHtmlMultiModule --no-parallel
+      - uses: JamesIves/github-pages-deploy-action@v4.4.3
+        with:
+          branch: gh-pages
+          folder: build/reflekt/dokka/htmlMultiModule
diff --git a/.gitignore b/.gitignore
@@ -2,3 +2,4 @@ build
 .idea
 .gradle
 reflekt-log.log
+*.hprof
diff --git a/build.gradle.kts b/build.gradle.kts
@@ -2,8 +2,11 @@ import io.gitlab.arturbosch.detekt.Detekt
 import io.gitlab.arturbosch.detekt.DetektPlugin
 import io.gitlab.arturbosch.detekt.extensions.DetektExtension
 import io.gitlab.arturbosch.detekt.report.ReportMergeTask
+import org.jetbrains.dokka.gradle.DokkaTaskPartial
 import org.jetbrains.reflekt.buildutils.*
+import java.net.URL
 
+@Suppress("DSL_SCOPE_VIOLATION") // https://youtrack.jetbrains.com/issue/KTIJ-19369
 plugins {
     `maven-publish`
     alias(libs.plugins.kosogor)
@@ -73,6 +76,22 @@ createDiktatTask()
 subprojects {
     apply(plugin = "maven-publish")
 
+    if (this@subprojects.name != "reflekt-plugin") {
+        apply(plugin = "org.jetbrains.dokka")
+
+        tasks.withType<DokkaTaskPartial> {
+            dokkaSourceSets.configureEach {
+                sourceLink {
+                    localDirectory.set(this@subprojects.file("src/main/kotlin"))
+
+                    remoteUrl.set(
+                        URL("https://github.com/JetBrains-Research/${rootProject.name}/tree/master/${this@subprojects.name}/src/main/kotlin/")
+                    )
+                }
+            }
+        }
+    }
+
     publishing {
         repositories {
             maven {

diff --git a/gradle-plugin/build.gradle.kts b/gradle-plugin/build.gradle.kts
@@ -1,5 +1,6 @@
 import tanvd.kosogor.proxy.publishPlugin
 
+@Suppress("DSL_SCOPE_VIOLATION") // https://youtrack.jetbrains.com/issue/KTIJ-19369
 plugins {
     `kotlin-dsl`
     alias(libs.plugins.kotlin.plugin.serialization)

diff --git a/gradle.properties b/gradle.properties
@@ -0,0 +1,2 @@
+kotlin.code.style=official
+org.gradle.jvmargs=-XX:MaxMetaspaceSize=512m
diff --git a/reflekt-plugin/build.gradle.kts b/reflekt-plugin/build.gradle.kts
@@ -1,5 +1,6 @@
 import tanvd.kosogor.proxy.publishJar
 
+@Suppress("DSL_SCOPE_VIOLATION") // https://youtrack.jetbrains.com/issue/KTIJ-19369
 plugins {
     alias(libs.plugins.kotlin.plugin.serialization)
 }