-
Notifications
You must be signed in to change notification settings - Fork 535
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Document new CLI command "create-job" (#887)
- Loading branch information
1 parent
2686eb4
commit a11b26a
Showing
1 changed file
with
31 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,31 @@ | ||
== create-job | ||
|
||
=== Purpose | ||
|
||
|
||
The `create-job` command creates a new scheduled job for the given base name. | ||
|
||
|
||
=== Examples | ||
|
||
---- | ||
grails create-job Scheduled | ||
grails create-job com.example.Scheduled | ||
---- | ||
|
||
=== Description | ||
|
||
|
||
Creates a new Quartz scheduled job with an empty 'execute' method. The argument is required. | ||
|
||
The name of the job can include a Java package, such as `com.example` in the last example above, but if one is not provided a default is used. So the first example will create the file `grails-app/jobs/<appname>/ScheduledJob.groovy` whereas the second one will create `grails-app/jobs/com/example/ScheduledJob.groovy`. Note that the first letter of the job name is always upper-cased when determining the class name. | ||
|
||
If you want the command to default to a different package for jobs, provide a value for `grails.project.groupId` in the link:{guidePath}/conf.html#config[runtime configuration]. | ||
|
||
Note that this command is just for convenience and you can also create jobs in your favourite text editor or IDE if you choose. | ||
|
||
Usage: | ||
[source,groovy] | ||
---- | ||
grails create-job <<name>> | ||
---- |
a11b26a
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@guillermocalvo Do you remember what the reason was for adding this page to the core documentation?
I don't think
create-job
is a valid command in the Grails CLI.I might be missing something but to my knowledge the
create-job
command is part of the grails-quartz plugin.Also this command (in grails-quartz) has not yet been upgraded to a
GrailsApplicationCommand
(to make it work with the new CLI in Grails 6).And once it has been upgraded, and the grails-quartz plugin is added to a project, it can be invoked with the gradle runCommand task:
$ ./gradlew runCommand -Pargs="create-job Scheduled"
a11b26a
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@matrei Yes, we added it back to the new CLI recently.
a11b26a
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Aha 👍 Thanks!