Skip to content

[stable34] chore(jobs): write proper documentation for job:history #61945

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
backportbot wants to merge 2 commits into
base: stable34
Choose a base branch
from
+5 −4
Open

[stable34] chore(jobs): write proper documentation for job:history #61945

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
515fbf8
chore(jobs): write proper documentation for job:history
Altahrim Jun 29, 2026
4e58812
chore(jobs): match documentation of job:history
Altahrim Jul 2, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions core/Command/Background/JobsHistory.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,10 +33,11 @@ protected function configure(): void {
parent::configure();

$help = <<<EOF
Display all currently running background jobs.
List historical job executions

You can find the following informations:
The output includes:
- <info>Run ID:</info> job identifier as found in database (Snowflake ID)
- <info>Status:</info> result of the job (Succeeded, Failed, Crashed)
- <info>Class:</info> class of the job
- <info>Started at:</info> start time of the job
- <info>Server ID:</info> server ID as defined in <options=bold>config.php</> (see `serverid`). Highlighted if it’s running on current server.
Expand All @@ -48,7 +49,7 @@ protected function configure(): void {

$this
->setName('background-job:history')
->setDescription('Show currently running jobs')
->setDescription('List historical job executions')
->setHelp($help)
->addOption('limit', 'l', InputOption::VALUE_REQUIRED, 'Maximum number of results returned by the command', 200)
->addOption('class', 'c', InputOption::VALUE_IS_ARRAY | InputOption::VALUE_REQUIRED, 'Filter by class name', [])
Expand Down
2 changes: 1 addition & 1 deletion core/Command/Background/RunningJobs.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ protected function configure(): void {
$help = <<<EOF
Display all currently running background jobs.

You can find the following informations:
The output includes:
- <info>Run ID:</info> job identifier a found in database (Snowflake ID)
- <info>Class:</info> class of the job
- <info>Started at:</info> start time of the job
Expand Down
Loading