Skip to content

Commit 1d8c1f6

Browse files
committed
add help
1 parent 9ed2571 commit 1d8c1f6

File tree

1 file changed

+20
-4
lines changed

1 file changed

+20
-4
lines changed

src/Console/Command/ReleaseCommand.php

Lines changed: 20 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -44,12 +44,28 @@ protected function configure()
4444
{
4545
parent::configure();
4646

47+
$help = <<<EOT
48+
The <info>release</info> command analyzes pull request of a given project to determine
49+
the changelog and the next version to release.
50+
51+
Usage:
52+
53+
<info>php dev-kit release doctrine-orm-admin-bundle</info>
54+
55+
The command will show what is the status of the project, then a list of pull requests
56+
made against selected branch (default: 3.x) with the following information: stability, name,
57+
labels, changelog, url.
58+
59+
After that, it will show what is the next version to release and the changelog for that release.
60+
61+
EOT;
62+
4763
$this
4864
->setName('release')
49-
->setDescription('Makes a release of a project.')
50-
->addArgument('project', InputArgument::REQUIRED, 'The project to do a release of.')
51-
->addOption('branch', null, InputOption::VALUE_OPTIONAL, 'Base branch to release', '3.x')
52-
;
65+
->setDescription('Helps with a project release.')
66+
->addArgument('project', InputArgument::REQUIRED, 'The project to release.')
67+
->addOption('branch', null, InputOption::VALUE_OPTIONAL, 'branch to release', '3.x')
68+
->setHelp($help);
5369
}
5470

5571
/**

0 commit comments

Comments
 (0)