Skip to content

Commit ae5942a

Browse files
jamesfredleyjamesfredley
authored
Merge pull request #1175 from apache/grailsw-s2-commands
Update documentation and commands to use ./grailsw instead of ./gradlew
2 parents 4dbe604 + f9d3c3e commit ae5942a

File tree

10 files changed

+32
-32
lines changed

10 files changed

+32
-32
lines changed

‎plugin-core/docs/src/docs/hierarchicalRoles.adoc‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ For example, running
9090

9191
[source,bash]
9292
----
93-
./gradlew runCommand "-Pargs=s2-create-role-hierarchy-entry com.yourapp.RoleHierarchyEntry"
93+
./grailsw s2-create-role-hierarchy-entry com.yourapp.RoleHierarchyEntry
9494
----
9595

9696
will generate this class in `grails-app/domain/com/yourapp/RoleHierarchyEntry.groovy`:

‎plugin-core/docs/src/docs/introduction/installation.adoc‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ dependencies {
6969
+
7070
[source,bash]
7171
```
72-
./gradlew runCommand "-Pargs=s2-quickstart com.yourapp User Role"
72+
./grailsw s2-quickstart s2-quickstart com.yourapp User Role
7373
```
7474

7575
=== Verifying Installation

‎plugin-core/docs/src/docs/scripts/s2-create-persistent-token.adoc‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,14 +26,14 @@ Creates a persistent token domain class for storing remember-me cookie informati
2626

2727
[source,bash]
2828
----
29-
./gradlew runCommand "-Pargs=s2-create-persistent-token <classname>"
29+
./grailsw s2-create-persistent-token <classname>
3030
----
3131

3232
.Example
3333

3434
[source,bash]
3535
----
36-
./gradlew runCommand "-Pargs=s2-create-persistent-token com.yourapp.PersistentLogin"
36+
./grailsw s2-create-persistent-token com.yourapp.PersistentLogin
3737
----
3838

3939
.Description

‎plugin-core/docs/src/docs/scripts/s2-create-role-hierarchy-entry.adoc‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,14 +26,14 @@ Creates a persistent role hierarchy entry domain class for storing role hierarch
2626

2727
[source,bash]
2828
----
29-
./gradlew runCommand "-Pargs=s2-create-role-hierarchy-entry <classname>"
29+
./grailsw s2-create-role-hierarchy-entry <classname>
3030
----
3131

3232
.Example
3333

3434
[source,bash]
3535
----
36-
./gradlew runCommand "-Pargs=s2-create-role-hierarchy-entry com.yourapp.RoleHierarchyEntry"
36+
./grailsw s2-create-role-hierarchy-entry com.yourapp.RoleHierarchyEntry
3737
----
3838

3939
.Description

‎plugin-core/docs/src/docs/scripts/s2-quickstart.adoc‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -30,29 +30,29 @@ The general format is:
3030

3131
[source,bash]
3232
----
33-
./gradlew runCommand "-Pargs=s2-quickstart DOMAIN_CLASS_PACKAGE USER_CLASS_NAME ROLE_CLASS_NAME [REQUESTMAP_CLASS_NAME] [--groupClassName=GROUP_CLASS_NAME]"
33+
./grailsw s2-quickstart DOMAIN_CLASS_PACKAGE USER_CLASS_NAME ROLE_CLASS_NAME [REQUESTMAP_CLASS_NAME] [--groupClassName=GROUP_CLASS_NAME]
3434
----
3535

3636
.Examples
3737

3838
[source,bash]
3939
----
40-
./gradlew runCommand "-Pargs=s2-quickstart com.yourapp User Role"
40+
./grailsw s2-quickstart s2-quickstart com.yourapp User Role
4141
----
4242

4343
[source,bash]
4444
----
45-
./gradlew runCommand "-Pargs=s2-quickstart com.yourapp User Role --groupClassName=RoleGroup"
45+
./grailsw s2-quickstart com.yourapp User Role --groupClassName=RoleGroup
4646
----
4747

4848
[source,bash]
4949
----
50-
./gradlew runCommand "-Pargs=s2-quickstart com.yourapp Person Authority Requestmap"
50+
./grailsw s2-quickstart com.yourapp Person Authority Requestmap
5151
----
5252

5353
[source,bash]
5454
----
55-
./gradlew runCommand "-Pargs=s2-quickstart --uiOnly"
55+
./grailsw s2-quickstart --uiOnly
5656
----
5757

5858
.Description

‎plugin-core/docs/src/docs/tutorials/usingControllerAnnotations.adoc‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ $ grails compile
4848

4949
[source,bash]
5050
----
51-
./gradlew runCommand "-Pargs=s2-quickstart com.mycompany.myapp User Role"
51+
./grailsw s2-quickstart com.mycompany.myapp User Role
5252
----
5353

5454
You can choose your names for your domain classes and package; these are just examples.

‎plugin-core/docs/src/docs/whatsNew.adoc‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ One of the notable improvements is the seamless transition to Grails 6. The plug
3232

3333
[source,shell]
3434
----
35-
./gradlew runCommand "-Pargs=s2-quickstart com.yourapp User Role"
35+
./grailsw s2-quickstart s2-quickstart com.yourapp User Role
3636
----
3737

3838
This aligns perfectly with Grails 6's development landscape, making your application's migration smoother than ever before.

‎plugin-core/plugin/grails-app/commands/grails.plugin.springsecurity/S2CreatePersistentTokenCommand.groovy‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,9 @@ import groovy.transform.CompileStatic
2323

2424
/**
2525
* Creates a persistent token domain class for the Spring Security Core plugin.
26-
* Usage: <code>./gradlew runCommand "-Pargs=s2-create-persistent-token [DOMAIN CLASS NAME]"</code>
26+
* Usage: <code>./grailsw s2-create-persistent-token [DOMAIN CLASS NAME]</code>
2727
*
28-
* For example: <code>./gradlew runCommand "-Pargs=s2-create-persistent-token com.yourapp.PersistentLogin"</code>
28+
* For example: <code>./grailsw s2-create-persistent-token com.yourapp.PersistentLogin</code>
2929
*
3030
* @author Puneet Behl
3131
* @since 6.0.0
@@ -37,9 +37,9 @@ class S2CreatePersistentTokenCommand implements GrailsApplicationCommand, Comman
3737
ConsoleLogger consoleLogger = GrailsConsole.getInstance()
3838

3939
private final static USAGE_MESSAGE = '''
40-
./gradlew runCommand "-Pargs=s2-create-persistent-token [DOMAIN CLASS NAME]"
40+
./grailsw s2-create-persistent-token [DOMAIN CLASS NAME]
4141
42-
For example: ./gradlew runCommand "-Pargs=s2-create-persistent-token com.yourapp.PersistentLogin"
42+
For example: ./grailsw s2-create-persistent-token com.yourapp.PersistentLogin
4343
'''
4444

4545
@Override

‎plugin-core/plugin/grails-app/commands/grails.plugin.springsecurity/S2CreateRoleHierarchyEntryCommand.groovy‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,8 @@ import groovy.transform.CompileStatic
2323

2424
/**
2525
* Creates a domain class for a persistent role hierarchy for the Spring Security Core plugin
26-
* Usage: <code>./gradlew runCommand "-Pargs=s2-create-role-hierarchy-entry [DOMAIN CLASS NAME]"
27-
* For example: <code>./gradlew runCommand "-Pargs=s2-create-role-hierarchy-entry com.yourapp.RoleHierarchyEntry"</code>
26+
* Usage: <code>./grailsw s2-create-role-hierarchy-entry [DOMAIN CLASS NAME]
27+
* For example: <code>./grailsw s2-create-role-hierarchy-entry com.yourapp.RoleHierarchyEntry</code>
2828
*
2929
* @author Puneet Behl
3030
* @since 6.0.0
@@ -33,9 +33,9 @@ import groovy.transform.CompileStatic
3333
class S2CreateRoleHierarchyEntryCommand implements GrailsApplicationCommand, CommandLineHelper, SkipBootstrap {
3434

3535
private static final String USAGE_MESSAGE = '''
36-
./gradlew runCommand "-Pargs=s2-create-role-hierarchy-entry [DOMAIN CLASS NAME]"
36+
./grailsw s2-create-role-hierarchy-entry [DOMAIN CLASS NAME]
3737
38-
For example: ./gradlew runCommand "-Pargs=s2-create-role-hierarchy-entry com.yourapp.RoleHierarchyEntry"
38+
For example: ./grailsw s2-create-role-hierarchy-entry com.yourapp.RoleHierarchyEntry
3939
'''
4040

4141
@Delegate

‎plugin-core/plugin/grails-app/commands/grails.plugin.springsecurity/S2QuickstartCommand.groovy‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -23,14 +23,14 @@ import groovy.transform.CompileStatic
2323

2424
/**
2525
* Creates domain classes and updates config settings for the Spring Security plugin.
26-
* Usage: <code>./gradlew runCommand "-Pargs=s2-quickstart [DOMAIN_CLASS_PACKAGE] [USER_CLASS_NAME] [ROLE_CLASS_NAME] [REQUEST_MAP_CLASS_NAME] --groupClassName=[GROUP_CLASS_NAME]"</code> or
26+
* Usage: <code>./grailsw s2-quickstart [DOMAIN_CLASS_PACKAGE] [USER_CLASS_NAME] [ROLE_CLASS_NAME] [REQUEST_MAP_CLASS_NAME] --groupClassName=[GROUP_CLASS_NAME]</code> or
2727
* <code>s2-quickstart --ui-only</code>
2828
*
2929
* For Example:
30-
* 1. <code>./gradlew runCommand "-Pargs=s2-quickstart com.yourapp User Role --groupClassName=RoleGroup"</code>
31-
* 2. <code>./gradlew runCommand "-Pargs=s2-quickstart com.yourapp Person Authority Requestmap"</code>
32-
* 3. <code>./gradlew runCommand "-Pargs=s2-quickstart --uiOnly"</code>
33-
* 4. <code>./gradlew runCommand "-Pargs=s2-quickstart com.yourapp User Role"</code>
30+
* 1. <code>./grailsw s2-quickstart com.yourapp User Role --groupClassName=RoleGroup</code>
31+
* 2. <code>./grailsw s2-quickstart com.yourapp Person Authority Requestmap</code>
32+
* 3. <code>./grailsw s2-quickstart --uiOnly</code>
33+
* 4. <code>./grailsw s2-quickstart s2-quickstart com.yourapp User Role</code>
3434
*
3535
* @author Puneet Behl
3636
* @since 6.0.0
@@ -51,13 +51,13 @@ class S2QuickstartCommand implements GrailsApplicationCommand, CommandLineHelper
5151
String description = 'Creates domain classes and updates config settings for the Spring Security plugin.'
5252

5353
private final static String USAGE_MESSAGE = '''
54-
./gradlew runCommand "-Pargs=s2-quickstart [DOMAIN-CLASS-PACKAGE] [USER-CLASS-NAME] [ROLE-CLASS-NAME] [REQUESTMAP-CLASS-NAME] --groupClassName=GROUP-CLASS-NAME"
55-
or ./gradlew runCommand "-Pargs=s2-quickstart --uiOnly"
54+
./grailsw s2-quickstart [DOMAIN-CLASS-PACKAGE] [USER-CLASS-NAME] [ROLE-CLASS-NAME] [REQUESTMAP-CLASS-NAME] --groupClassName=GROUP-CLASS-NAME
55+
or ./grailsw s2-quickstart --uiOnly
5656
57-
Example: ./gradlew runCommand "-Pargs=s2-quickstart com.yourapp User Role"
58-
Example: ./gradlew runCommand "-Pargs=s2-quickstart com.yourapp User Role --groupClassName=RoleGroup"
59-
Example: ./gradlew runCommand "-Pargs=s2-quickstart com.yourapp Person Authority Requestmap"
60-
Example: ./gradlew runCommand "-Pargs=s2-quickstart --uiOnly"
57+
Example: ./grailsw s2-quickstart s2-quickstart com.yourapp User Role
58+
Example: ./grailsw s2-quickstart com.yourapp User Role --groupClassName=RoleGroup
59+
Example: ./grailsw s2-quickstart com.yourapp Person Authority Requestmap
60+
Example: ./grailsw s2-quickstart --uiOnly
6161
'''
6262

6363
@Delegate

0 commit comments

Comments
 (0)