Skip to content

Commit

Permalink
notes about some jobs still might be executed
Browse files Browse the repository at this point in the history
  • Loading branch information
musketyr committed Nov 26, 2024
1 parent 030ed40 commit 4e51053
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion docs/guide/src/docs/asciidoc/usage.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -258,14 +258,16 @@ TIP: If https://github.com/agorapulse/micronaut-snitch[Micronaut Snitch] is pres

== CLI Runner

You can run a single job from the command line using the `com.agorapulse.worker.runner.JobRunner` class as the main class. The arguments are the names of the jobs to run. All other jobs are disabled, even when enabled in the configuration. The application will run until all jobs are finished.
You can run a single job from the command line using the `com.agorapulse.worker.runner.JobRunner` class as the main class. The arguments are the names of the jobs to run. All other jobs are disabled, even when enabled in the configuration (see corner cases below). The application will run until all jobs are finished.

[source,shell]
.Run Job from CLI
----
java -cp myapp-shadow.jar com.agorapulse.worker.runner.JobRunner sample-job other-job
----

WARNING: In some corner cases, some unrelated jobs can still be executed if they have a very short delay or frequency if they are manually enabled in the configuration. Please, prefer annotation driven jobs over configuring them manually in the configuration to avoid this issue.

== Management

You can use `jobs` management endpoint, by default located at `/jobs`, to see the status of all the jobs in the application.
Expand Down

0 comments on commit 4e51053

Please sign in to comment.