Skip to content

Commit 6caf3c3

Browse files
authored
Merge pull request #14809 from irllyliketoast/7.0.x
Fixing Issue #14173 – Update `grails` Command Documentation for Grails 7
2 parents 7d765a7 + 1bf6af4 commit 6caf3c3

24 files changed

+222
-399
lines changed

.gitignore

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,4 +53,5 @@ target
5353
tmp/
5454
!grails-fields/src/main/groovy/org/grails/scaffolding/registry/output
5555
!etc/bin
56-
etc/bin/results
56+
etc/bin/results
57+
.vscode/

gradle/functional-test-config.gradle

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ configurations.configureEach {
5454
}
5555
}
5656

57-
// work around for parallel builds due to https://github.com/bertramdev/asset-pipeline/issues/177
57+
// work around for parallel builds due to https://github.com/wondrify/asset-pipeline/issues/177
5858
if ('assetCompile' in tasks.names) {
5959
tasks.named('assetCompile').configure { Task task ->
6060
task.outputs.dir rootProject.layout.buildDirectory.dir('asset-serialize')

grails-doc/src/en/guide/REST/angularJsProfile.adoc

Lines changed: 0 additions & 113 deletions
This file was deleted.

grails-doc/src/en/guide/REST/angularProfile.adoc

Lines changed: 0 additions & 113 deletions
This file was deleted.

grails-doc/src/en/guide/REST/restProfile.adoc

Lines changed: 7 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,9 @@ specific language governing permissions and limitations
1717
under the License.
1818
////
1919

20-
Since Grails 3.1, Grails supports a tailored profile for creating REST applications that provides a more focused set of dependencies and commands.
20+
Grails supports a tailored profile for creating REST applications that provides a more focused set of dependencies and commands.
2121

22-
To get started with the REST profile, create an application specifying `rest-api` as the name of the profile:
22+
To get started with the REST profile using the Grails Shell CLI, create an application specifying `rest-api` as the name of the profile:
2323

2424
[source,bash]
2525
----
@@ -30,7 +30,7 @@ This will create a new REST application that provides the following features:
3030

3131
* Default set of commands for creating and generating REST endpoints
3232
* Defaults to using JSON views for rendering responses (see the next section)
33-
* Fewer plugins than the default Grails plugin (no GSP, no Asset Pipeline, nothing HTML related)
33+
* Fewer plugins than the default Grails web profile (no GSP, no Asset Pipeline, nothing HTML related)
3434
3535
You will notice for example in the `grails-app/views` directory that there are `*.gson` files for rendering the default index page and as well as any 404 and 500 errors.
3636

@@ -44,20 +44,14 @@ $ grails generate-all my.api.Book
4444

4545
Instead of CRUD HTML interface a REST endpoint is generated that produces JSON responses. In addition, the generated functional and unit tests by default test the REST endpoint.
4646

47-
48-
49-
50-
51-
Using Grails Forge, Grails supports a tailored profile for creating REST applications that provides a more focused set of dependencies and commands.
52-
53-
To get started with a REST API-type application:
47+
To generate a REST application using the Forge CLI, use the following:
5448

5549
[source,console]
5650
----
57-
$ grails create-restapi my-api
51+
$ grails -t forge create-restapi my-api
5852
----
5953

60-
This will create a new REST application that provides the following features:
54+
This will create a new REST application with the same focused setup as above:
6155

6256
* Default set of commands for creating and generating REST endpoints
6357
* Defaults to using JSON views for rendering responses (see the next section)
@@ -75,4 +69,4 @@ $ ./gradlew runCommand -Pargs="generate-all my.api.Book"
7569

7670
NOTE: The generate-* commands are only available after adding the `org.apache.grails:grails-scaffolding` dependency to your project. They are not available by default in a REST application. Also, they will no longer produce *.gson files as that was a feature of the REST API-profile.
7771
78-
Instead of CRUD HTML interface a REST endpoint is generated that produces JSON responses. In addition, the generated functional and unit tests by default test the REST endpoint.
72+
Instead of CRUD HTML interface a REST endpoint is generated that produces JSON responses. In addition, the generated functional and unit tests by default test the REST endpoint.

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@ bootRun{
109109
----
110110

111111

112-
=== non-interactive mode
112+
=== Non-interactive mode
113113

114114

115115
When you run a script manually and it prompts you for information, you can answer the questions and continue running the script. But when you run a script as part of an automated process, for example a continuous integration build server, there's no way to "answer" the questions. So you can pass the `\--non-interactive` switch to the script command to tell Grails to accept the default answer for any questions, for example whether to install a missing plugin.

0 commit comments

Comments
 (0)