Skip to content

Commit 7efbf62

Browse files
committed
Update documentation for plugin groupId and compatibility
Corrects the plugin groupId in installation instructions from 'com.symentis' to 'org.grails.plugins', updates the Grails and plugin version compatibility table, removes outdated groupId change notes, and reorders the changelog include in the documentation index.
1 parent 0c1a35a commit 7efbf62

File tree

4 files changed

+5
-7
lines changed

4 files changed

+5
-7
lines changed

plugin/src/docs/index.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,6 @@ Other formats: link:audit-logging-{VERSION}.pdf[PDF], link:audit-logging-{VERSIO
1919

2020
include::introduction.adoc[]
2121

22-
include::changelog.adoc[]
23-
2422
include::installation.adoc[]
2523

2624
include::upgrading.adoc[]
@@ -32,3 +30,5 @@ include::usage.adoc[]
3230
include::stamping.adoc[]
3331

3432
include::implementation.adoc[]
33+
34+
include::changelog.adoc[]

plugin/src/docs/installation.adoc

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,10 @@
22
=== Dependencies
33
Add to your build.gradle project dependencies block:
44

5-
WARNING: Due to the move to Maven Central, the plugin groupId has changed from org.grails.plugin to com.symentis.
6-
75
[source,groovy]
86
----
97
dependencies {
10-
compile 'com.symentis:audit-logging:{VERSION}'
8+
compile 'org.grails.plugins:audit-logging:{VERSION}'
119
}
1210
----
1311
Then run the following to refresh gradle dependencies:

plugin/src/docs/introduction.adoc

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ It also provides a convenient way to add Update and Create user stamping by exte
99
[cols="1,2",width="50%",options="header,footer"]
1010
|====================
1111
|Grails Version | Audit Logging Plugin Version
12+
|7.0.x | 6.0.x
1213
|4.0.0 and later | 5.0.0 (participating in Transactions). This is the recommended version if you use Grails 4.
1314
|4.0.x | 4.0.x
1415
|3.3.x | 3.0.x
@@ -21,7 +22,7 @@ It also provides a convenient way to add Update and Create user stamping by exte
2122
=== GORM Compatibility
2223

2324
This plugin is GORM agnostic, so you can use it with the GORM implementation of your choice
24-
(Hibernate 4 or 5, MongoDB, etc.).
25+
(Hibernate 5, MongoDB, etc.).
2526

2627
Please note, that only Hibernate5 is tested during development. If an issue occurs with your ORM mapper,
2728
please file a GitHub issue.

plugin/src/docs/upgrading.adoc

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
== Upgrading to 5.0.x
22

33
** The 5.0.0 version has some significant changes to the 4.0.x version.
4-
* The groupId of the plugin has changed from org.grails.plugin to com.symentis
54
* The configuration keys are the same as in 4.0.x
65
* The mechanism to audit log transaction data has changed. We now participate in transactions and queue up audit logs. The audit logs are flushed with the current transaction. If the current transaction fails, no audit logs of this transaction are committed. Due to this major change, the plugin is currently not ORM agnostic and for now depends on Hibernate. As the plugin itself does not support other GORM implementations like Mongo (see #179), this shouldn't affect current projects.
76

0 commit comments

Comments
 (0)