Fix build failures caused by antora changes

jonatan-ivanov · Sep 14, 2023 · 4feaa7f · 4feaa7f
1 parent 06f4235
commit 4feaa7f
Show file tree

Hide file tree

Showing 17 changed files with 95 additions and 178 deletions.
diff --git a/.github/workflows/deploy-docs.yml b/.github/workflows/deploy-docs.yml
@@ -15,7 +15,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           ref: docs-build
           fetch-depth: 1

diff --git a/build.gradle b/build.gradle
@@ -35,10 +35,8 @@ buildscript {
 
 // TODO: remove this hack, see: https://github.com/nebula-plugins/nebula-release-plugin/issues/213
 def releaseStage = findProperty('release.stage')
-if (!project.hasProperty("antora")) {
-    apply plugin: 'com.netflix.nebula.release'
-    release.defaultVersionStrategy = nebula.plugin.release.git.opinion.Strategies.SNAPSHOT
-}
+apply plugin: 'com.netflix.nebula.release'
+release.defaultVersionStrategy = nebula.plugin.release.git.opinion.Strategies.SNAPSHOT
 
 apply plugin: 'io.github.gradle-nexus.publish-plugin'
 apply from: 'dependencies.gradle'
@@ -298,11 +296,8 @@ subprojects {
         apply plugin: 'com.netflix.nebula.maven-apache-license'
         apply plugin: 'com.netflix.nebula.publish-verification'
         apply plugin: 'com.netflix.nebula.contacts'
-
-        if (!project.hasProperty("antora")) {
-            apply plugin: 'com.netflix.nebula.info'
-            apply plugin: 'com.netflix.nebula.project'
-        }
+        apply plugin: 'com.netflix.nebula.info'
+        apply plugin: 'com.netflix.nebula.project'
 
         if (project.name != 'micrometer-bom') {
             apply plugin: 'biz.aQute.bnd.builder'
@@ -415,8 +410,7 @@ subprojects {
     }
 
     def check = tasks.findByName('check')
-    boolean antora = project.hasProperty("antora")
-    if (check && !antora) project.rootProject.tasks.releaseCheck.dependsOn check
+    if (check) project.rootProject.tasks.releaseCheck.dependsOn check
 }
 
 nexusPublishing {

diff --git a/config/checkstyle/checkstyle-suppressions.xml b/config/checkstyle/checkstyle-suppressions.xml
@@ -10,6 +10,7 @@
 	<suppress checks="IllegalImport" files="test[\\/]java[\\/]io[\\/]micrometer[\\/]core[\\/]instrument[\\/]binder[\\/]jersey[\\/]server.+" />
 	<suppress checks="IllegalImport" files="test[\\/]java[\\/]io[\\/]micrometer[\\/]jersey.+" />
 	<suppress checks="IllegalImport" files="test[\\/]java[\\/]io[\\/]micrometer[\\/]core[\\/]instrument.+Tests.java" />
+	<suppress checks="IllegalImport" files="docs[\\/].+" />
 
 	<suppress checks="JavadocPackageCheck" files="benchmarks[\\/].+" />
 	<suppress checks="JavadocPackageCheck" files="samples[\\/].+" />

diff --git a/docs/antora.yml b/docs/antora.yml
@@ -6,7 +6,7 @@ nav:
 ext:
   collector:
     run:
-      command: gradlew -q -PbuildSrc.skipTests=true -Pantora "-Dorg.gradle.jvmargs=-Xmx3g -XX:+HeapDumpOnOutOfMemoryError" :docs:generateAntoraResources
+      command: ./gradlew -q -PbuildSrc.skipTests=true "-Dorg.gradle.jvmargs=-Xmx3g -XX:+HeapDumpOnOutOfMemoryError" :docs:generateAntoraResources
       local: true
     scan:
       dir: ./build/generated-antora-resources

diff --git a/docs/build.gradle b/docs/build.gradle
@@ -1,11 +1,48 @@
-plugins {
-    id 'java'
-    id 'io.spring.antora.generate-antora-yml' version '0.0.1'
-    id 'org.antora' version '1.0.0'
-    id 'java-library'
+buildscript {
+	dependencyLocking {
+		lockAllConfigurations()
+	}
+
+	repositories {
+		mavenCentral()
+		gradlePluginPortal()
+	}
+
+	dependencies {
+		classpath 'io.spring.gradle.antora:spring-antora-plugin:0.0.1'
+		classpath 'org.antora:gradle-antora-plugin:1.0.0'
+	}
+}
+
+apply plugin: 'java'
+apply plugin: 'io.spring.antora.generate-antora-yml'
+apply plugin: 'org.antora'
+
+description = 'Micrometer Docs'
+
+repositories {
+   mavenCentral()
 }
 
-description = "Micrometer Docs"
+dependencies {
+    implementation project(':micrometer-core')
+    implementation 'io.micrometer:context-propagation'
+    implementation 'ch.qos.logback:logback-classic'
+    implementation 'org.slf4j:slf4j-api'
+
+    testImplementation project(':micrometer-test')
+    testImplementation project(':micrometer-observation-test')
+    testImplementation 'org.aspectj:aspectjweaver'
+    testImplementation 'org.junit.jupiter:junit-jupiter'
+    testImplementation 'org.mockito:mockito-inline'
+    testImplementation 'org.assertj:assertj-core'
+    testImplementation 'org.springframework:spring-context'
+    testImplementation 'io.projectreactor:reactor-core'
+    testImplementation 'io.projectreactor:reactor-test'
+    testImplementation 'io.netty:netty-transport'
+    testImplementation 'org.apache.httpcomponents.client5:httpclient5'
+    testImplementation 'io.javalin:javalin:latest.release'
+}
 
 antora {
 	version = '3.2.0-alpha.2'
@@ -26,23 +63,18 @@ antora {
 	]
 }
 
-
-tasks.named("generateAntoraYml") {
-    asciidocAttributes = project.provider( {
-        return  ["micrometer-version": project.version.toString()]
-    } )
+tasks.named('generateAntoraYml') {
+    asciidocAttributes = project.provider {
+        return  ['micrometer-version': project.version.toString()]
+    }
 }
 
-tasks.create("generateAntoraResources") {
+tasks.create('generateAntoraResources') {
     dependsOn 'generateAntoraYml'
 }
 
-tasks.named("antora") {
-    dependsOn "generateAntoraResources"
-}
-
-tasks.named("antora") {
-    dependsOn "test"
+tasks.named('antora') {
+    dependsOn 'generateAntoraResources', 'test'
 }
 
 jar {
@@ -53,27 +85,14 @@ javadoc {
     enabled = false
 }
 
-repositories {
-   mavenCentral()
+tasks.withType(AbstractPublishToMaven).configureEach {
+	enabled = false
 }
 
-dependencies {
-    implementation project(":micrometer-core")
-    implementation 'io.micrometer:context-propagation'
-    implementation 'ch.qos.logback:logback-classic'
-    implementation 'org.slf4j:slf4j-api'
-
-    testImplementation project(":micrometer-test")
-    testImplementation project(":micrometer-observation-test")
-    testImplementation 'org.aspectj:aspectjweaver'
-    testImplementation 'org.junit.jupiter:junit-jupiter'
-    testImplementation 'org.mockito:mockito-inline'
-    testImplementation 'org.assertj:assertj-core'
-    testImplementation 'org.springframework:spring-context'
-    testImplementation 'io.projectreactor:reactor-core'
-    testImplementation 'io.projectreactor:reactor-test'
-    testImplementation 'io.netty:netty-transport'
-    testImplementation 'org.apache.httpcomponents.client5:httpclient5'
-    testImplementation 'io.javalin:javalin:latest.release'
+downloadBaseline {
+	enabled = false
 }
 
+japicmp {
+	enabled = false
+}
diff --git a/docs/gradle.lockfile b/docs/gradle.lockfile
diff --git a/docs/src/test/java/io/micrometer/docs/context/DefaultContextSnapshotTests.java b/docs/src/test/java/io/micrometer/docs/context/DefaultContextSnapshotTests.java
@@ -1,11 +1,11 @@
 /*
- * Copyright 2002-2022 the original author or authors.
+ * Copyright 2023 VMware, Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at
  *
- *      https://www.apache.org/licenses/LICENSE-2.0
+ * https://www.apache.org/licenses/LICENSE-2.0
  *
  * Unless required by applicable law or agreed to in writing, software
  * distributed under the License is distributed on an "AS IS" BASIS,

diff --git a/docs/src/test/java/io/micrometer/docs/context/ObservationThreadLocalAccessor.java b/docs/src/test/java/io/micrometer/docs/context/ObservationThreadLocalAccessor.java
@@ -1,11 +1,11 @@
 /*
- * Copyright 2002-2022 the original author or authors.
+ * Copyright 2023 VMware, Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at
  *
- *      https://www.apache.org/licenses/LICENSE-2.0
+ * https://www.apache.org/licenses/LICENSE-2.0
  *
  * Unless required by applicable law or agreed to in writing, software
  * distributed under the License is distributed on an "AS IS" BASIS,

diff --git a/docs/src/test/java/io/micrometer/docs/context/ObservationThreadLocalHolder.java b/docs/src/test/java/io/micrometer/docs/context/ObservationThreadLocalHolder.java
@@ -1,11 +1,11 @@
 /*
- * Copyright 2002-2022 the original author or authors.
+ * Copyright 2023 VMware, Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at
  *
- *      https://www.apache.org/licenses/LICENSE-2.0
+ * https://www.apache.org/licenses/LICENSE-2.0
  *
  * Unless required by applicable law or agreed to in writing, software
  * distributed under the License is distributed on an "AS IS" BASIS,

diff --git a/docs/src/test/java/io/micrometer/docs/observation/ObservationConfiguringTests.java b/docs/src/test/java/io/micrometer/docs/observation/ObservationConfiguringTests.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2017 VMware, Inc.
+ * Copyright 2023 VMware, Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/docs/src/test/java/io/micrometer/docs/observation/ObservationHandlerTests.java b/docs/src/test/java/io/micrometer/docs/observation/ObservationHandlerTests.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2017 VMware, Inc.
+ * Copyright 2023 VMware, Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/docs/src/test/java/io/micrometer/docs/observation/ObservationInstrumentingTests.java b/docs/src/test/java/io/micrometer/docs/observation/ObservationInstrumentingTests.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2017 VMware, Inc.
+ * Copyright 2023 VMware, Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -15,7 +15,6 @@
  */
 package io.micrometer.docs.observation;
 
-
 import com.github.tomakehurst.wiremock.junit5.WireMockRuntimeInfo;
 import com.github.tomakehurst.wiremock.junit5.WireMockTest;
 import io.javalin.Javalin;

diff --git a/docs/src/test/java/io/micrometer/docs/observation/ObservationTestingTests.java b/docs/src/test/java/io/micrometer/docs/observation/ObservationTestingTests.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2017 VMware, Inc.
+ * Copyright 2023 VMware, Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/docs/src/test/resources/docs-generator-build.gradle b/docs/src/test/resources/docs-generator-build.gradle
@@ -1,5 +1,5 @@
 /*
- * Copyright 2022 VMware, Inc.
+ * Copyright 2023 VMware, Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.