Skip to content

Commit

Permalink
octopus-rm-gradle-plugin-26 Fix artifact coordinates in doc (#27)
Browse files Browse the repository at this point in the history
Co-authored-by: Alexander Ryabokon <[email protected]>
  • Loading branch information
aryabokon and Alexander Ryabokon authored Jul 31, 2023
1 parent 034e4b3 commit 4a47851
Show file tree
Hide file tree
Showing 16 changed files with 44 additions and 44 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Gradle org.octopusden.release-management plugin
# Gradle org.octopusden.octopus-release-management plugin

Plugin for integration continuous integration and release management in gradle projects.

Expand Down Expand Up @@ -30,4 +30,4 @@ The required parameters to test:\

## Parameters

- <b>nexus</b> - The parameter to mark that it needs to publish two plugins or one(without it two plugins will be published)
- <b>nexus</b> - The parameter to mark that it needs to publish two plugins or one(without it two plugins will be published)
48 changes: 24 additions & 24 deletions docs/src/docs/asciidoc/release-management-gradle-plugin.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,10 @@ v: New hope

== Introduction

org.octopusden.release-management gradle plugin is intended for supporting and Continuous integration.
org.octopusden.octopus-release-management gradle plugin is intended for supporting and Continuous integration.


The actual org.octopusden.release-management gradle plugin version is v{version-label}
The actual org.octopusden.octopus-release-management gradle plugin version is v{version-label}

== Terminology

Expand Down Expand Up @@ -191,37 +191,37 @@ image::images/teamcity-configure-gradle-wrapper.png[TeamCity build configuration

==== The plugins DSL

To support and Continues integration the project has to be configured to use org.octopusden.release-management plugin.
To support and Continues integration the project has to be configured to use org.octopusden.octopus-release-management plugin.

[source,groovy]
----
plugins {
id 'org.octopusden.release-management'
id 'org.octopusden.octopus-release-management'
}
----

No need more. The staging plugin will by applied by plugin and project will be configured.

==== Legacy Plugin Application

Applying the org.octopusden.release-management plugin with the buildscript block:
Applying the org.octopusden.octopus-release-management plugin with the buildscript block:

:markup-in-source: verbatim,quotes

[source,groovy,subs="attributes"]
----
buildscript {
dependencies {
classpath "org.octopusden.release-management:org.octopusden.release-management:${project.findProperty('release-management.version') ?: '{version-label}'}"
classpath "org.octopusden.octopus-release-management:org.octopusden.octopus-release-management:${project.findProperty('release-management.version') ?: '{version-label}'}"
}
}
apply plugin: 'org.octopusden.release-management'
apply plugin: 'org.octopusden.octopus-release-management'
----

=== The OW Release Management gradle plugin version

The recommended way to configure _org.octopusden.release-management_ plugin version is to use plugins DSL and project properties placed in gradle.properties
The recommended way to configure _org.octopusden.octopus-release-management_ plugin version is to use plugins DSL and project properties placed in gradle.properties

This method will require timeFor that need to configure plugin management in project _settings_ file:

Expand All @@ -230,7 +230,7 @@ This method will require timeFor that need to configure plugin management in pro
----
pluginManagement {
plugins {
id 'org.octopusden.release-management' version settings['release-management.version']
id 'org.octopusden.octopus-release-management' version settings['release-management.version']
}
}
----
Expand All @@ -240,7 +240,7 @@ pluginManagement {
----
pluginManagement {
plugins {
id("org.octopusden.release-management") version(extra["release-management.version"] as String)
id("org.octopusden.octopus-release-management") version(extra["release-management.version"] as String)
}
}
----
Expand Down Expand Up @@ -270,15 +270,15 @@ The user build customization (specify additional parameters, options and etc) ha

=== Publishing artifacts

To publish artifacts need to apply _org.octopusden.release-management_ and maven-publish plugins and configure publishing extension.
To publish artifacts need to apply _org.octopusden.octopus-release-management_ and maven-publish plugins and configure publishing extension.

No repository configuration is needed anymore.

.For example
[source,groovy]
----
plugins {
id 'org.octopusden.release-management'
id 'org.octopusden.octopus-release-management'
id 'java-library'
}
Expand Down Expand Up @@ -314,12 +314,12 @@ publishing {

https://docs.gradle.org/current/dsl/org.gradle.api.publish.maven.MavenPom.html[Official Gradle guide] to customize publishing pom.xml

To specify dependencies from declared configurations apply _'org.octopusden.release-management'_ plugin and use *declareDependencies* method:
To specify dependencies from declared configurations apply _'org.octopusden.octopus-release-management'_ plugin and use *declareDependencies* method:

[source,groovy]
----
plugins {
id 'org.octopusden.release-management'
id 'org.octopusden.octopus-release-management'
}
configurations {
fc_spartak
Expand All @@ -345,7 +345,7 @@ To declare from several configurations
[source,groovy]
----
plugins {
id 'org.octopusden.release-management'
id 'org.octopusden.octopus-release-management'
}
configurations {
fc_spartak
Expand Down Expand Up @@ -414,7 +414,7 @@ Configure artifacts to publish:
[source,groovy]
----
plugins {
id 'org.octopusden.release-management'
id 'org.octopusden.octopus-release-management'
id 'maven-publish'
}
Expand Down Expand Up @@ -504,7 +504,7 @@ platform-commons.version=1.2.687
----
pluginManagement {
plugins {
id 'org.octopusden.release-management' version settings['release-management.version']
id 'org.octopusden.octopus-release-management' version settings['release-management.version']
id 'org.jetbrains.kotlin.jvm' version settings['kotlin.version']
id 'org.springframework.boot' version settings['spring-boot.version']
}
Expand All @@ -515,7 +515,7 @@ pluginManagement {
[source,groovy,subs="attributes+"]
----
plugins {
id 'org.octopusden.release-management'
id 'org.octopusden.octopus-release-management'
id 'java-library'
id 'org.springframework.boot'
id 'org.jetbrains.kotlin.jvm'
Expand Down Expand Up @@ -560,7 +560,7 @@ publishing {

== Register dependencies for RM 2.0

The _'org.octopusden.release-management'_ Gradle plugin includes all required functionality
The _'org.octopusden.octopus-release-management'_ Gradle plugin includes all required functionality

No additional plugin applying is needed.

Expand All @@ -570,7 +570,7 @@ To register dependencies in RM 2.0 which should be included in component's relea
[source,groovy]
----
plugins {
id 'org.octopusden.release-management'
id 'org.octopusden.octopus-release-management'
}
releaseManagement {
Expand Down Expand Up @@ -599,7 +599,7 @@ Use _com.platformlib.plugins.gradle.wrapper.task.DockerTask_ task to execute com
[source,groovy]
----
plugins {
id 'org.octopusden.release-management'
id 'org.octopusden.octopus-release-management'
}
task buildGoApplication(type: com.platformlib.plugins.gradle.wrapper.task.DockerTask) {
Expand All @@ -618,7 +618,7 @@ If there are several tasks use the same configuration then it could be configure
[source,groovy,subs="attributes"]
----
plugins {
id 'org.octopusden.release-management'
id 'org.octopusden.octopus-release-management'
}
ext {
Expand Down Expand Up @@ -654,7 +654,7 @@ The task outputs' could be used as source for artifact publishing
plugins {
id 'base'
id 'maven-publish'
id 'org.octopusden.release-management'
id 'org.octopusden.octopus-release-management'
}
ext {
Expand Down Expand Up @@ -724,7 +724,7 @@ For more details please visit to wiki page of Automation Tool.

The project can be configured for auto updating used components' dependencies versions.

Auto update configured is done via autoUpdateDependencies extension which is applied by _org.octopusden.release-management_ gradle plugin:
Auto update configured is done via autoUpdateDependencies extension which is applied by _org.octopusden.octopus-release-management_ gradle plugin:

.use component(<Map>) method:
[source,groovy]
Expand Down
2 changes: 1 addition & 1 deletion ft-docker/build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ plugins {

//
version = '1.0-SNAPSHOT'
group = 'org.octopusden.release-management.ft'
group = 'org.octopusden.octopus-release-management.ft'

description "Release management gradle plugin ${version} docker functional tests"

Expand Down
2 changes: 1 addition & 1 deletion ft-docker/settings.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@ pluginManagement {
id 'org.jetbrains.kotlin.jvm' version settings['kotlin.version']
}
}
rootProject.name='org.octopusden.release-management.ft-docker'
rootProject.name='org.octopusden.octopus-release-management.ft-docker'
2 changes: 1 addition & 1 deletion ft/build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ plugins {

//
version = '1.0-SNAPSHOT'
group = 'org.octopusden.release-management.ft'
group = 'org.octopusden.octopus-release-management.ft'

description "Release management gradle plugin ${version} functional tests"

Expand Down
2 changes: 1 addition & 1 deletion ft/settings.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,6 @@ pluginManagement {
id 'org.jetbrains.kotlin.jvm' version settings['kotlin.version']
}
}
rootProject.name='org.octopusden.release-management.ft'
rootProject.name='org.octopusden.octopus-release-management.ft'

include ':artifactory-manager'
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ class ReleaseManagementPluginTest {
fun testPublishArtifacts(project: String, artifacts: Collection<String>) {
val releaseManagementVersion: String = System.getenv()["__RELEASE_MANAGEMENT_VERSION__"] ?: throw IllegalStateException("The __RELEASE_MANAGEMENT_VERSION__ environment variable is not set")
val buildVersion: String = System.getenv()["__BUILD_VERSION__"] ?: throw IllegalStateException("The __BUILD_VERSION__ environment variable is not set")
val componentName = "org.octopusden.release-management.ft.$project"
val componentName = "org.octopusden.octopus-release-management.ft.$project"

val projectPath = Paths.get(ReleaseManagementPluginTest::class.java.getResource("/publish/$project")!!.toURI())
logger.debug("Project directory {}", projectPath)
Expand Down Expand Up @@ -86,7 +86,7 @@ class ReleaseManagementPluginTest {
val buildInfo = getBuildInfo(componentName, buildVersion)
assertNotNull(buildInfo, "Build $componentName:$buildVersion is not registered in artifactory")
artifacts.forEach { artifact ->
val module = buildInfo!!.modules.find { it.id == "org.octopusden.release-management.ft:$artifact:$buildVersion" }
val module = buildInfo!!.modules.find { it.id == "org.octopusden.octopus-release-management.ft:$artifact:$buildVersion" }
assertNotNull(module, "Module $artifact:$buildVersion wasn't found in build")
val moduleArtifact = module!!.artifacts.find { it.name == "$artifact-${buildVersion}.jar" }
assertNotNull(moduleArtifact, "Module artifact $artifact-${buildVersion}.jar hasn't been found in $buildInfo")
Expand Down Expand Up @@ -186,7 +186,7 @@ class ReleaseManagementPluginTest {
val buildVersion: String = System.getenv()["__BUILD_VERSION__"] ?: throw IllegalStateException("The __BUILD_VERSION__ environment variable is not set")
val classifiers = arrayOf("lib", "bin")
classifiers.forEach { classifier ->
val componentName = "org.octopusden.release-management.ft.publishConfigs_$classifier"
val componentName = "org.octopusden.octopus-release-management.ft.publishConfigs_$classifier"
val projectPath = Paths.get(ReleaseManagementPluginTest::class.java.getResource("/publish/sqlprs")!!.toURI())
logger.debug("Project directory {}", projectPath)
val gradleCommandAndLineProperties = Properties()
Expand Down Expand Up @@ -222,4 +222,4 @@ class ReleaseManagementPluginTest {
}
}
}
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ plugins {
id 'org.octopusden.octopus-release-management'
}

group = 'org.octopusden.release-management.ft'
group = 'org.octopusden.octopus-release-management.ft'

apply plugin: 'maven-publish'

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ buildscript {
}

allprojects {
group = 'org.octopusden.release-management.ft'
group = 'org.octopusden.octopus-release-management.ft'
version = rootProject.version
rootProject.buildscript.repositories.each {
repositories.add(it)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ buildscript {
apply plugin: 'org.octopusden.octopus-release-management'

allprojects {
group = 'org.octopusden.release-management.ft'
group = 'org.octopusden.octopus-release-management.ft'
}

configure(subprojects) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ buildscript {
apply plugin: 'org.octopusden.octopus-release-management'

allprojects {
group = 'org.octopusden.release-management.ft'
group = 'org.octopusden.octopus-release-management.ft'
}

apply plugin: 'java'
Expand Down
2 changes: 1 addition & 1 deletion ft/src/test/resources/publish/multi-module/build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ plugins {
}

allprojects {
group = 'org.octopusden.release-management.ft'
group = 'org.octopusden.octopus-release-management.ft'
}

configure(subprojects) {
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
apply plugin: 'maven-publish'

group = 'org.octopusden.release-management.ft'
group = 'org.octopusden.octopus-release-management.ft'
version = project.hasProperty("buildVersion") ? buildVersion : "1.0.DEV"

buildscript {
Expand All @@ -22,4 +22,4 @@ publishing {
artifact("src/README.jar")
}
}
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ plugins {
id 'java-library'
}

group = 'org.octopusden.release-management.ft'
group = 'org.octopusden.octopus-release-management.ft'

apply plugin: 'maven-publish'

Expand Down
2 changes: 1 addition & 1 deletion ft/src/test/resources/publish/single-module/build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ plugins {
id 'java-library'
}

group = 'org.octopusden.release-management.ft'
group = 'org.octopusden.octopus-release-management.ft'

apply plugin: 'maven-publish'

Expand Down
2 changes: 1 addition & 1 deletion ft/src/test/resources/publish/sqlprs/build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ plugins {
id 'maven-publish'
}

group='org.octopusden.release-management.ft'
group='org.octopusden.octopus-release-management.ft'

configurations {
builds
Expand Down

0 comments on commit 4a47851

Please sign in to comment.