octopus-rm-gradle-plugin-26 Fix documentation

* octopus-rm-gradle-plugin-26 release-management.version -> octopus-release-management.version * octopus-rm-gradle-plugin-26 Ability to set custom header in doc && typo * octopus-rm-gradle-plugin-26 dockerRegistry -> docker.registry in doc * octopus-rm-gradle-plugin-26 Fix header in doc ---------
octopusden · Aug 2, 2023 · 5332562 · 5332562
1 parent 4a47851
commit 5332562
Show file tree

Hide file tree

Showing 44 changed files with 77 additions and 73 deletions.
diff --git a/docs/build.gradle b/docs/build.gradle
@@ -6,8 +6,9 @@ plugins {
 }
 
 version = project.findProperty('buildVersion') ?: '1.0-SNAPSHOT'
+def header = project.findProperty('header').toString() ?: 'Octopus release management gradle plugin'
 def implLoggingCore = project.findProperty('implLoggingCore').toString() ?: ''
-def dockerRegestry = project.findProperty('dockerRegestry').toString() ?: 'registry.hub.docker.com'
+def dockerRegistry = project.findProperty('docker.registry').toString() ?: 'registry.hub.docker.com'
 def golangCommons = project.findProperty('golangCommons').toString() ?: 'com.example.golang.commons:commons:1.0.0:@zip'
 def repositoryUrl = project.findProperty('repositoryUrl').toString() ?: 'https://example.com'
 
@@ -16,9 +17,10 @@ repositories {
 }
 
 asciidoctorj {
-    attributes 'version-label': version,
+    attributes 'header': header,
+               'version-label': version,
                'impl-logging-core': implLoggingCore,
-               'docker-regestry': dockerRegestry,
+               'docker-registry': dockerRegistry,
                'golang-commons': golangCommons,
                'repository-url': repositoryUrl
 }
@@ -55,9 +57,10 @@ tasks.register('publishToWiki', DockerTask) {
            "PUBLISHING_STRATEGY"    : "REPLACE_ANCESTOR",
            "ORPHAN_REMOVAL_STRATEGY": "KEEP_ORPHANS",
            "NOTIFY_WATCHERS"        : "false",
-           "ATTRIBUTES"             : "{\"version-label\": \"$version\", " +
+           "ATTRIBUTES"             : "{\"header\": \"$header\", " +
+                                      "\"version-label\": \"$version\", " +
                                       "\"impl-logging-core\":\"${deQuoted(implLoggingCore).replaceAll('"','\\\\"')}\"," +
-                                      "\"docker-regestry\":\"$dockerRegestry\"," +
+                                      "\"docker-registry\":\"$dockerRegistry\"," +
                                       "\"golang-commons\":\"$golangCommons\"," +
                                       "\"repository-url\":\"$repositoryUrl\"}",
            "PUBLISHING_STRATEGY"    : "REPLACE_ANCESTOR",

diff --git a/docs/src/docs/asciidoc/release-management-gradle-plugin.adoc b/docs/src/docs/asciidoc/release-management-gradle-plugin.adoc
@@ -1,4 +1,5 @@
-= Octopus release management gradle plugin
+:header: Octopus Release Management Gradle plugin
+= {header}
 Gradle
 v: New hope
 :toc:
@@ -187,7 +188,7 @@ The gradle build step on TeamCity build configuration has to be configured to us
 
 image::images/teamcity-configure-gradle-wrapper.png[TeamCity build configuration gradle wrapper settings]
 
-=== Use OW Release Management gradle plugin
+=== Use Octopus Release Management gradle plugin
 
 ==== The plugins DSL
 
@@ -212,7 +213,7 @@ Applying the org.octopusden.octopus-release-management plugin with the buildscri
 ----
 buildscript {
     dependencies {
-         classpath "org.octopusden.octopus-release-management:org.octopusden.octopus-release-management:${project.findProperty('release-management.version') ?: '{version-label}'}"
+         classpath "org.octopusden.octopus-release-management:org.octopusden.octopus-release-management:${project.findProperty('octopus-release-management.version') ?: '{version-label}'}"
      }
 }
 
@@ -230,7 +231,7 @@ This method will require timeFor that need to configure plugin management in pro
 ----
 pluginManagement {
     plugins {
-        id 'org.octopusden.octopus-release-management' version settings['release-management.version']
+        id 'org.octopusden.octopus-release-management' version settings['octopus-release-management.version']
     }
 }
 ----
@@ -240,16 +241,16 @@ pluginManagement {
 ----
 pluginManagement {
     plugins {
-        id("org.octopusden.octopus-release-management") version(extra["release-management.version"] as String)
+        id("org.octopusden.octopus-release-management") version(extra["octopus-release-management.version"] as String)
     }
 }
 ----
 
-and put property _release-management.version_ with version in the project _gradle.properties_
+and put property _octopus-release-management.version_ with version in the project _gradle.properties_
 
 [subs="attributes"]
 ----
-release-management.version={version-label}
+octopus-release-management.version={version-label}
 ----
 
 === TeamCity compile and continues delivery build configuration
@@ -493,7 +494,7 @@ If TeamCity project build configuration is not based on standard templates and i
 .gradle.properties
 [subs="attributes"]
 ----
-release-management.version={version-label}
+octopus-release-management.version={version-label}
 kotlin.version=1.3.70
 spring-boot.version=2.2.5.RELEASE
 platform-commons.version=1.2.687
@@ -504,7 +505,7 @@ platform-commons.version=1.2.687
 ----
 pluginManagement {
     plugins {
-        id 'org.octopusden.octopus-release-management' version settings['release-management.version']
+        id 'org.octopusden.octopus-release-management' version settings['octopus-release-management.version']
         id 'org.jetbrains.kotlin.jvm'            version settings['kotlin.version']
         id 'org.springframework.boot'            version settings['spring-boot.version']
     }
@@ -626,7 +627,7 @@ ext {
 }
 
 platformDockerWrapper {
-    image = '{docker-regestry}/platform/go-build:1.1.7'
+    image = '{docker-registry}/platform/go-build:1.1.7'
     workDir = '/buildDir'
     dockerOptions = ['--network', 'host']
     bindMounts = ["$rootDir:/project/src/${repository}.git", "$buildDir:/buildDir", "$buildDir/deps/:/deps", "$buildDir/go-cache:/.cache"]
@@ -662,7 +663,7 @@ ext {
 }
 
 platformDockerWrapper {
-    image = '{docker-regestry}/platform/go-build:1.1.7'
+    image = '{docker-registry}/platform/go-build:1.1.7'
     workDir = '/buildDir'
     dockerOptions = ['--network', 'host']
     bindMounts = ["$rootDir:/project/src/${repository}.git", "$buildDir:/buildDir", "$buildDir/deps/:/deps", "$buildDir/go-cache:/.cache"]

diff --git a/...lin/org/octopusden/release/management/plugins/gradle/ReleaseManagementPluginDockerTest.kt b/...lin/org/octopusden/release/management/plugins/gradle/ReleaseManagementPluginDockerTest.kt
@@ -35,7 +35,7 @@ class ReleaseManagementPluginDockerTest {
                 .commandAndArguments("$projectPath/gradlew")
                 .build()
                 .execute(
-                    "-Prelease-management.version=$releaseManagementVersion",
+                    "-Poctopus-release-management.version=$releaseManagementVersion",
                     "-Pescrow.build-phase=ASSEMBLE",
                     "-Pdocker.registry=$dockerRegistry",
                     "-PpackageName=$packageName",
@@ -46,7 +46,7 @@ class ReleaseManagementPluginDockerTest {
                 .toCompletableFuture()
                 .get()
         assertEquals(0, processInstance.exitCode, "Gradle execution failure")
-        assertThat(processInstance.stdOut).contains("Pull docker image docker.artifactory." + java.lang.System.getProperty("packageName") + ".com/platform/go-build:1.1.7")
+        assertThat(processInstance.stdOut).contains("Pull docker image $dockerRegistry/platform/go-build:1.1.7")
     }
 
     @Test
@@ -66,7 +66,7 @@ class ReleaseManagementPluginDockerTest {
             .commandAndArguments("$projectPath/gradlew")
             .build()
             .execute(
-                "-Prelease-management.version=$releaseManagementVersion",
+                "-Poctopus-release-management.version=$releaseManagementVersion",
                 "-Pescrow.build-phase=ASSEMBLE",
                 "-Pdocker.registry=$dockerRegistry",
                 "bootBuildImage"
@@ -77,4 +77,4 @@ class ReleaseManagementPluginDockerTest {
         assertThat(processInstance.stdOut).anyMatch{logEntry -> logEntry.contains("Pulled builder image '$dockerRegistry/cnbs/uds-stack-builder")}
         assertThat(processInstance.stdOut).anyMatch{logEntry -> logEntry.contains("Pulled run image '$dockerRegistry/cnbs/uds-stack-run")}
     }
-}
+}
diff --git a/ft-docker/src/test/resources/mesh-agent2/gradle.properties b/ft-docker/src/test/resources/mesh-agent2/gradle.properties
@@ -1,2 +1,2 @@
 use_dev_repository=all
-release-management.version=1.0-SNAPSHOT
+octopus-release-management.version=1.0-SNAPSHOT
diff --git a/ft-docker/src/test/resources/mesh-agent2/settings.gradle b/ft-docker/src/test/resources/mesh-agent2/settings.gradle
@@ -1,6 +1,6 @@
 pluginManagement {
   plugins {
-    id 'org.octopusden.octopus-release-management' version settings['release-management.version']
+    id 'org.octopusden.octopus-release-management' version settings['octopus-release-management.version']
   }
 }
 

diff --git a/ft-docker/src/test/resources/uds/gradle.properties b/ft-docker/src/test/resources/uds/gradle.properties
@@ -1,4 +1,4 @@
 use_dev_repository=all
-release-management.version=1.0-SNAPSHOT
+octopus-release-management.version=1.0-SNAPSHOT
 spring-boot.version=2.6.1
-spring-dependency-management.version=1.0.11.RELEASE
+spring-dependency-management.version=1.0.11.RELEASE
diff --git a/ft-docker/src/test/resources/uds/settings.gradle b/ft-docker/src/test/resources/uds/settings.gradle
@@ -1,9 +1,9 @@
 pluginManagement {
     plugins {
-        id 'org.octopusden.octopus-release-management' version settings['release-management.version']
+        id 'org.octopusden.octopus-release-management' version settings['octopus-release-management.version']
         id 'org.springframework.boot' version settings['spring-boot.version']
         id 'io.spring.dependency-management' version settings['spring-dependency-management.version']
     }
 }
 
-rootProject.name = 'releng-update-dependencies-service'
+rootProject.name = 'releng-update-dependencies-service'
diff --git a/.../kotlin/org/octopusden/release/management/plugins/gradle/ReleaseManagementPluginRunner.kt b/.../kotlin/org/octopusden/release/management/plugins/gradle/ReleaseManagementPluginRunner.kt
@@ -45,7 +45,7 @@ fun gradleProcessInstance(init: TestGradleDSL.() -> Unit): Pair<ProcessInstance,
         .processInstance { processInstanceConfiguration -> processInstanceConfiguration.unlimited() }
         .commandAndArguments("$projectPath/gradlew", "--no-daemon")
         .build()
-        .execute(*(listOf("-Prelease-management.version=$releaseManagementVersion") + testGradleDSL.tasks + testGradleDSL.additionalArguments).toTypedArray())
+        .execute(*(listOf("-Poctopus-release-management.version=$releaseManagementVersion") + testGradleDSL.tasks + testGradleDSL.additionalArguments).toTypedArray())
         .toCompletableFuture()
         .join(), projectPath)
-}
+}
diff --git a/...n/org/octopusden/release/management/plugins/gradle/AutoUpdateDependenciesExtensionTest.kt b/...n/org/octopusden/release/management/plugins/gradle/AutoUpdateDependenciesExtensionTest.kt
@@ -26,7 +26,7 @@ class AutoUpdateDependenciesExtensionTest {
             Arguments.of("auto-mapping",
                 mapOf(
                     "a-doc.version" to "3.53.3-137",
-                    "release-management.version" to "1.0-SNAPSHOT"
+                    "octopus-release-management.version" to "1.0-SNAPSHOT"
                 ),
                 emptyList<ComponentDependency>()
             ),
@@ -149,4 +149,4 @@ class AutoUpdateDependenciesExtensionTest {
         assertThat(processInstance.first.stdOut).containsAnyElementsOf(listOf("-----BEGIN AUDC-----", "  \"declared\" : {", "  \"configured\" : [ {", "-----END AUDC-----"))
     }
 
-}
+}
diff --git a/...st/kotlin/org/octopusden/release/management/plugins/gradle/ReleaseManagementPluginTest.kt b/...st/kotlin/org/octopusden/release/management/plugins/gradle/ReleaseManagementPluginTest.kt
@@ -146,7 +146,7 @@ class ReleaseManagementPluginTest {
             .workDirectory(projectPath)
             .commandAndArguments("$projectPath/gradlew")
             .build()
-            .execute("clean", "assemble", "generatePomFileForMavenPublication", "-Prelease-management.version=$releaseManagementVersion", "-PpackageName=$packageName")
+            .execute("clean", "assemble", "generatePomFileForMavenPublication", "-Poctopus-release-management.version=$releaseManagementVersion", "-PpackageName=$packageName")
             .toCompletableFuture()
             .get()
         assertEquals(0, processInstance.exitCode, "Gradle execution failure")
@@ -169,7 +169,7 @@ class ReleaseManagementPluginTest {
                 .mapBatExtension()
                 .mapCmdExtension()
                 .workDirectory(projectPath)
-                .commandAndArguments("$projectPath/gradlew", "-Prelease-management.version=$releaseManagementVersion")
+                .commandAndArguments("$projectPath/gradlew", "-Poctopus-release-management.version=$releaseManagementVersion")
                 .processInstance { it.unlimited() }
                 .build()
                 .execute(*commandLineArguments.toTypedArray())

diff --git a/ft/src/test/resources/auto-update-dependencies/auto-mapping/gradle.properties b/ft/src/test/resources/auto-update-dependencies/auto-mapping/gradle.properties
@@ -1,5 +1,5 @@
 use_dev_repository=plugins
 
-release-management.version=1.0-SNAPSHOT
+octopus-release-management.version=1.0-SNAPSHOT
 
 a-doc.version=3.53.3-137
diff --git a/ft/src/test/resources/auto-update-dependencies/auto-mapping/settings.gradle b/ft/src/test/resources/auto-update-dependencies/auto-mapping/settings.gradle
@@ -1,7 +1,7 @@
 //
 pluginManagement {
     plugins {
-        id 'org.octopusden.octopus-release-management' version settings['release-management.version']
+        id 'org.octopusden.octopus-release-management' version settings['octopus-release-management.version']
     }
 }
 

diff --git a/ft/src/test/resources/auto-update-dependencies/custom-mapping/gradle.properties b/ft/src/test/resources/auto-update-dependencies/custom-mapping/gradle.properties
@@ -1,7 +1,7 @@
 use_dev_repository=plugins
 
-release-management.version=1.0-SNAPSHOT
+octopus-release-management.version=1.0-SNAPSHOT
 
 pl-commons-version=1.1
 
-as-server.version=1.7.3182
+as-server.version=1.7.3182
diff --git a/ft/src/test/resources/auto-update-dependencies/custom-mapping/settings.gradle b/ft/src/test/resources/auto-update-dependencies/custom-mapping/settings.gradle
@@ -1,7 +1,7 @@
 //
 pluginManagement {
     plugins {
-        id 'org.octopusden.octopus-release-management' version settings['release-management.version']
+        id 'org.octopusden.octopus-release-management' version settings['octopus-release-management.version']
     }
 }
 

diff --git a/ft/src/test/resources/auto-update-dependencies/default-values/gradle.properties b/ft/src/test/resources/auto-update-dependencies/default-values/gradle.properties
@@ -1,7 +1,7 @@
 use_dev_repository=plugins
 
-release-management.version=1.0-SNAPSHOT
+octopus-release-management.version=1.0-SNAPSHOT
 
 pl-commons-version=1.1
 
-as-server.version=1.7.3182
+as-server.version=1.7.3182
diff --git a/ft/src/test/resources/auto-update-dependencies/default-values/settings.gradle b/ft/src/test/resources/auto-update-dependencies/default-values/settings.gradle
@@ -1,7 +1,7 @@
 //
 pluginManagement {
     plugins {
-        id 'org.octopusden.octopus-release-management' version settings['release-management.version']
+        id 'org.octopusden.octopus-release-management' version settings['octopus-release-management.version']
     }
 }
 

diff --git a/ft/src/test/resources/auto-update-dependencies/dump-to-output/gradle.properties b/ft/src/test/resources/auto-update-dependencies/dump-to-output/gradle.properties
@@ -1,7 +1,7 @@
 use_dev_repository=plugins
 
-release-management.version=1.0-SNAPSHOT
+octopus-release-management.version=1.0-SNAPSHOT
 
 pl-commons-version=1.1
 
-as-server.version=1.7.3182
+as-server.version=1.7.3182
diff --git a/ft/src/test/resources/auto-update-dependencies/dump-to-output/settings.gradle b/ft/src/test/resources/auto-update-dependencies/dump-to-output/settings.gradle
@@ -1,7 +1,7 @@
 //
 pluginManagement {
     plugins {
-        id 'org.octopusden.octopus-release-management' version settings['release-management.version']
+        id 'org.octopusden.octopus-release-management' version settings['octopus-release-management.version']
     }
 }
 

diff --git a/ft/src/test/resources/auto-update-dependencies/kotlin-dsl/gradle.properties b/ft/src/test/resources/auto-update-dependencies/kotlin-dsl/gradle.properties
@@ -1,6 +1,6 @@
 use_dev_repository=plugins
 
-release-management.version=1.0-SNAPSHOT
+octopus-release-management.version=1.0-SNAPSHOT
 
 platform-commons.version=1.2.687
-escrow.version=5.327
+escrow.version=5.327
diff --git a/ft/src/test/resources/auto-update-dependencies/kotlin-dsl/settings.gradle b/ft/src/test/resources/auto-update-dependencies/kotlin-dsl/settings.gradle
@@ -1,7 +1,7 @@
 //
 pluginManagement {
     plugins {
-        id 'org.octopusden.octopus-release-management' version settings['release-management.version']
+        id 'org.octopusden.octopus-release-management' version settings['octopus-release-management.version']
     }
 }
 

diff --git a/ft/src/test/resources/auto-update-dependencies/version-range/gradle.properties b/ft/src/test/resources/auto-update-dependencies/version-range/gradle.properties
@@ -1,7 +1,7 @@
 use_dev_repository=plugins
 
-release-management.version=1.0-SNAPSHOT
+octopus-release-management.version=1.0-SNAPSHOT
 
 pl-commons-version=1.1
 
-as-server.version=1.7.3182
+as-server.version=1.7.3182
diff --git a/ft/src/test/resources/auto-update-dependencies/version-range/settings.gradle b/ft/src/test/resources/auto-update-dependencies/version-range/settings.gradle
@@ -1,7 +1,7 @@
 //
 pluginManagement {
     plugins {
-        id 'org.octopusden.octopus-release-management' version settings['release-management.version']
+        id 'org.octopusden.octopus-release-management' version settings['octopus-release-management.version']
     }
 }
 

diff --git a/ft/src/test/resources/declare-pom-dependencies/single-module/gradle.properties b/ft/src/test/resources/declare-pom-dependencies/single-module/gradle.properties
@@ -1,3 +1,3 @@
-release-management.version=1.0-SNAPSHOT
+octopus-release-management.version=1.0-SNAPSHOT
 # To enable access to non released versions of the org.octopusden.octopus-release-management gradle plugin
 use_dev_repository=plugins
diff --git a/ft/src/test/resources/declare-pom-dependencies/single-module/settings.gradle b/ft/src/test/resources/declare-pom-dependencies/single-module/settings.gradle
@@ -1,7 +1,7 @@
 //
 pluginManagement {
     plugins {
-        id 'org.octopusden.octopus-release-management' version settings['release-management.version']
+        id 'org.octopusden.octopus-release-management' version settings['octopus-release-management.version']
     }
 }
 

diff --git a/ft/src/test/resources/publish/multi-module-4.10.3/build.gradle b/ft/src/test/resources/publish/multi-module-4.10.3/build.gradle
@@ -1,6 +1,6 @@
 buildscript {
     dependencies {
-         classpath "org.octopusden.octopus-release-management:org.octopusden.octopus-release-management:${project.findProperty('release-management.version') ?: '1.0-SNAPSHOT'}"
+         classpath "org.octopusden.octopus-release-management:org.octopusden.octopus-release-management:${project.findProperty('octopus-release-management.version') ?: '1.0-SNAPSHOT'}"
      }
 }
 

diff --git a/ft/src/test/resources/publish/multi-module-with-root-publish-4.10.3/build.gradle b/ft/src/test/resources/publish/multi-module-with-root-publish-4.10.3/build.gradle
@@ -1,6 +1,6 @@
 buildscript {
     dependencies {
-         classpath "org.octopusden.octopus-release-management:org.octopusden.octopus-release-management:${project.findProperty('release-management.version') ?: '1.0-SNAPSHOT'}"
+         classpath "org.octopusden.octopus-release-management:org.octopusden.octopus-release-management:${project.findProperty('octopus-release-management.version') ?: '1.0-SNAPSHOT'}"
      }
 }
 

diff --git a/ft/src/test/resources/publish/multi-module-with-root-publish-4.10.3/gradle.properties b/ft/src/test/resources/publish/multi-module-with-root-publish-4.10.3/gradle.properties
@@ -1,4 +1,4 @@
 # To enable access to non released versions of the org.octopusden.octopus-release-management gradle plugin
 use_dev_repository=buildscript
 
-release-management.version=1.0-SNAPSHOT
+octopus-release-management.version=1.0-SNAPSHOT
diff --git a/ft/src/test/resources/publish/multi-module/gradle.properties b/ft/src/test/resources/publish/multi-module/gradle.properties
@@ -1,4 +1,4 @@
 # To enable access to non released versions of the org.octopusden.octopus-release-management gradle plugin
 use_dev_repository=plugins
 
-release-management.version=1.0-SNAPSHOT
+octopus-release-management.version=1.0-SNAPSHOT