Skip to content

Commit 48e9045

Browse files
authored
Merge pull request #15288 from jdaugherty/7.0.x
documentation - removing old coordinates, assume the bom is applied, and add rxjava3 references
2 parents 92edc85 + 49710de commit 48e9045

File tree

17 files changed

+34
-29
lines changed

17 files changed

+34
-29
lines changed

grails-doc/src/en/guide/async/asyncGorm.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ Since Grails 3.3, the asynchronous part of GORM is optional. To enable it you fi
2828
[source,groovy]
2929
.build.gradle
3030
----
31-
implementation "org.grails:grails-datastore-gorm-async"
31+
implementation "org.apache.grails:grails-datamapping-async"
3232
----
3333

3434
Then in your domain classes you wish to allow asynchronous processing you should use the `AsyncEntity` trait:

grails-doc/src/en/guide/async/asyncPromises.adoc

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ To use the Grails Promise abstraction you should add a dependency on the `async`
2424
[source,groovy,subs="attributes"]
2525
.build.gradle
2626
----
27-
implementation "org.apache.grails:grails-async:{version}"
27+
implementation "org.apache.grails:grails-async"
2828
----
2929

3030
=== Promise Basics
@@ -98,7 +98,7 @@ However, the design of the Grails promises framework is such that you can swap o
9898
[source,groovy,subs="attributes"]
9999
.build.gradle
100100
----
101-
runtimeOnly "org.grails:grails-async-rxjava:{GrailsVersion}"
101+
runtimeOnly 'org.apache.grails.async:grails-async-rxjava3'
102102
----
103103

104104
With the above in place RxJava 1.x will be used to create `Promise` instances.
@@ -121,6 +121,10 @@ The following table summarizes the available implementation and the dependency t
121121
|`grails-async-rxjava2`
122122
|`org.grails.async.factory.rxjava2.RxPromiseFactory`
123123

124+
|RxJava 3.x
125+
|`grails-async-rxjava3`
126+
|`org.grails.async.factory.rxjava3.RxPromiseFactory`
127+
124128
|===
125129

126130
You can also override the `grails.async.PromiseFactory` class used by `Promises` by setting the `promiseFactory` static field.

grails-doc/src/en/guide/async/events.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ To use the Grails Events abstraction you should add a dependency on the `events`
2626
[source,groovy,subs="attributes"]
2727
.build.gradle
2828
----
29-
implementation "org.apache.grails:grails-events:{version}"
29+
implementation 'org.apache.grails:grails-events'
3030
----
3131

3232
If no asynchronous framework is present on the classpath then by default Grails creates an EventBus based off of the currently active `PromiseFactory`. The default implementation is link:{api}org/grails/async/factory/future/CachedThreadPoolPromiseFactory.html[CachedThreadPoolPromiseFactory] which uses a thread pool that will create threads as needed (the same as `java.util.concurrent.Executors.newCachedThreadPool()`).
@@ -36,7 +36,7 @@ If you wish to use a popular async framework such as RxJava as the `EventBus` im
3636
[source,groovy,subs="attributes"]
3737
.build.gradle
3838
----
39-
runtimeOnly "org.grails:grails-events-rxjava:{GrailsVersion}"
39+
runtimeOnly 'org.apache.grails.events:grails-events-rxjava3'
4040
----
4141

4242
The following table summarizes async framework support and the necessary dependency:

grails-doc/src/en/guide/async/rxjava.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ To get started simply declare a dependency on the plugin in `build.gradle`:
2626
----
2727
dependencies {
2828
//...
29-
implementation 'org.apache.grails:grails-rxjava:{version}'
29+
implementation 'org.apache.grails:grails-rxjava3'
3030
}
3131
----
3232

grails-doc/src/en/guide/commandLine.adoc

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -222,16 +222,17 @@ Grails now utilizes the Gradle Build System for project management. The project'
222222
[source, groovy]
223223
----
224224
plugins {
225-
id 'org.apache.grails.gradle.grails-web' version 'x.y.z' // Grails plugin
225+
id 'org.apache.grails.gradle.grails-web' version "{version}" // Grails Application Gradle Plugin
226226
}
227227
228228
repositories {
229229
mavenCentral()
230230
}
231231
232232
dependencies {
233+
implementation platform("org.apache.grails:grails-bom:{version}")
233234
implementation 'org.springframework.boot:spring-boot-starter'
234-
implementation 'org.grails:grails-core'
235+
implementation 'org.apache.grails:grails-core'
235236
// Add more dependencies as needed...
236237
}
237238
----

grails-doc/src/en/guide/commandLine/gradleBuild/gradleDependencies.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -62,16 +62,16 @@ Note that version numbers are not present in the majority of the dependencies.
6262

6363
This is thanks to the Spring dependency management plugin which automatically configures `grails-bom` as a Maven BOM via the Grails Gradle Plugin. This defines the default dependency versions for most commonly used dependencies and plugins.
6464

65-
For a Grails App, applying `org.grails:grails-gradle-plugin` will automatically configure the `grails-bom`. No other steps required.
65+
For a Grails App, applying `org.apache.grails.gradle.grails-web` will automatically configure the `grails-bom`. No other steps required.
6666

67-
For Plugins and Projects which do not use `org.grails:grails-gradle-plugin`, you can apply the `grails-bom` in one of the following two ways.
67+
For Plugins and Projects which do not use `org.apache.grails.gradle.grails-web`, you can apply the `grails-bom` in one of the following two ways.
6868

6969
build.gradle, using Gradle Platforms:
7070
[source,groovy]
7171
----
7272
dependencies {
7373
implementation platform("org.apache.grails:grails-bom:{GrailsVersion}")
74-
// all other dependencies
74+
//...
7575
}
7676
----
7777

grails-doc/src/en/guide/profiles/profileStructure.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -112,9 +112,9 @@ A map of scopes and dependencies to configure. The `excludes` scope can be used
112112
----
113113
dependencies:
114114
- scope: excludes
115-
coords: "org.grails:hibernate:*"
115+
coords: "org.apache.grails:grails-data-hibernate5:*"
116116
- scope: build
117-
coords: "org.grails:grails-gradle-plugin:$grailsVersion"
117+
coords: "org.apache.grails:grails-gradle-plugins:{GrailsVersion}"
118118
- scope: compile
119119
coords: "org.springframework.boot:spring-boot-starter-logging"
120120
- scope: compile

grails-doc/src/en/guide/scaffolding.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ The way for an application to express a dependency on the scaffolding plugin is
2828
----
2929
dependencies {
3030
// ...
31-
implementation "org.apache.grails:grails-scaffolding:{version}"
31+
implementation "org.apache.grails:grails-scaffolding"
3232
// ...
3333
}
3434
----

grails-doc/src/en/guide/testing/unitTesting/installation.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ To install the unit testing support library add the following dependency to the
2121
`dependencies` block of your `build.gradle` in a Grails application or plugin:
2222

2323
[source,groovy,subs="attributes"]
24-
testCompile "org.grails:grails-gorm-testing-support:{version}"
25-
testCompile "org.grails:grails-web-testing-support:{version}"
24+
testCompile "org.apache.grails:grails-testing-support-datamapping"
25+
testCompile "org.apache.grails:grails-testing-support-web"
2626

2727
NOTE: The dependencies are only required to implement unit tests for Grails Artifacts. Also, if you are not unit testing domain activity, you may not need the GORM testing support library.

grails-doc/src/en/guide/theWebLayer/fields/fieldsInstallation.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,6 @@ The plugin is available on Maven Central and should be a dependency like this:
2222
[source,groovy,subs="attributes"]
2323
----
2424
dependencies {
25-
implementation 'org.apache.grails:grails-fields:{version}'
25+
implementation 'org.apache.grails:grails-fields'
2626
}
2727
----

0 commit comments

Comments
 (0)