Skip to content

Commit

Permalink
♻️ update: move the git:changelog logic to ChangelogCmd
Browse files Browse the repository at this point in the history
  • Loading branch information
@inhere
inhere committed Jan 14, 2023
1 parent 43b6190 commit d50813f
Show file tree
Hide file tree
Showing 4 changed files with 222 additions and 187 deletions.
3 changes: 3 additions & 0 deletions app/Console/Controller/Gitx/GitHubController.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@
use Inhere\Kite\Console\SubCmd\Gitflow\UpdatePushCmd;
use Inhere\Kite\Console\SubCmd\GitxCmd\AddCommitCmd;
use Inhere\Kite\Console\SubCmd\GitxCmd\AddCommitPushCmd;
use Inhere\Kite\Console\SubCmd\GitxCmd\ChangelogCmd;
use Inhere\Kite\Console\SubCmd\GitxCmd\GitEmojiCmd;
use Inhere\Kite\Console\SubCmd\GitxCmd\GitTagCmd;
use Inhere\Kite\Helper\AppHelper;
Expand Down Expand Up @@ -66,6 +67,7 @@ protected static function commandAliases(): array
UpdateNoPushCmd::getName() => UpdateNoPushCmd::aliases(),
AddCommitCmd::getName() => AddCommitCmd::aliases(),
AddCommitPushCmd::getName() => AddCommitPushCmd::aliases(),
ChangelogCmd::getName() => ChangelogCmd::aliases(),
]);
}

Expand All @@ -79,6 +81,7 @@ protected function subCommands(): array
GitEmojiCmd::class,
UpdatePushCmd::class,
UpdateNoPushCmd::class,
ChangelogCmd::class,
AddCommitCmd::class,
AddCommitPushCmd::class,
];
Expand Down
3 changes: 3 additions & 0 deletions app/Console/Controller/Gitx/GitLabController.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@
use Inhere\Kite\Console\SubCmd\GitlabCmd\ResolveConflictCmd;
use Inhere\Kite\Console\SubCmd\GitxCmd\AddCommitCmd;
use Inhere\Kite\Console\SubCmd\GitxCmd\AddCommitPushCmd;
use Inhere\Kite\Console\SubCmd\GitxCmd\ChangelogCmd;
use Inhere\Kite\Console\SubCmd\GitxCmd\GitEmojiCmd;
use Inhere\Kite\Console\SubCmd\GitxCmd\GitLogCmd;
use Inhere\Kite\Helper\AppHelper;
Expand Down Expand Up @@ -89,6 +90,7 @@ protected static function commandAliases(): array
UpdateNoPushCmd::getName() => UpdateNoPushCmd::aliases(),
AddCommitCmd::getName() => AddCommitCmd::aliases(),
AddCommitPushCmd::getName() => AddCommitPushCmd::aliases(),
ChangelogCmd::getName() => ChangelogCmd::aliases(),
];
}

Expand All @@ -108,6 +110,7 @@ protected function subCommands(): array
UpdateNoPushCmd::class,
AddCommitCmd::class,
AddCommitPushCmd::class,
ChangelogCmd::class,
];
}

Expand Down
191 changes: 4 additions & 187 deletions app/Console/Controller/Gitx/GitxController.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,11 @@
use Inhere\Kite\Common\Cmd;
use Inhere\Kite\Common\CmdRunner;
use Inhere\Kite\Common\GitLocal\GitHub;
use Inhere\Kite\Console\Component\Clipboard;
use Inhere\Kite\Console\Manager\GitBranchManager;
use Inhere\Kite\Console\SubCmd\BranchCmd;
use Inhere\Kite\Console\SubCmd\GitxCmd\AddCommitCmd;
use Inhere\Kite\Console\SubCmd\GitxCmd\AddCommitPushCmd;
use Inhere\Kite\Console\SubCmd\GitxCmd\BranchCmd;
use Inhere\Kite\Console\SubCmd\GitxCmd\ChangelogCmd;
use Inhere\Kite\Console\SubCmd\GitxCmd\GitEmojiCmd;
use Inhere\Kite\Console\SubCmd\GitxCmd\GitLogCmd;
use Inhere\Kite\Console\SubCmd\GitxCmd\GitTagCmd;
Expand All @@ -28,12 +28,6 @@
use Inhere\Kite\Helper\AppHelper;
use Inhere\Kite\Helper\GitUtil;
use Inhere\Kite\Kite;
use PhpGit\Changelog\Filter\KeywordsFilter;
use PhpGit\Changelog\Formatter\GithubReleaseFormatter;
use PhpGit\Changelog\Formatter\SimpleFormatter;
use PhpGit\Changelog\GitChangeLog;
use PhpGit\Git;
use PhpGit\Info\TagsInfo;
use PhpGit\Repo;
use Throwable;
use Toolkit\Cli\Cli;
Expand All @@ -42,10 +36,8 @@
use Toolkit\PFlag\FlagsParser;
use Toolkit\Stdlib\Helper\Assert;
use Toolkit\Stdlib\Obj\DataObject;
use Toolkit\Stdlib\Str;
use Toolkit\Sys\Proc\ProcTasks;
use function realpath;
use function strtolower;

/**
* Class GitxController
Expand All @@ -69,7 +61,6 @@ public static function aliases(): array
protected static function commandAliases(): array
{
return [
'changelog' => ['chlog', 'clog', 'cl'],
'tagDelete' => [
'tag-del',
'tagdel',
Expand Down Expand Up @@ -100,6 +91,7 @@ protected static function commandAliases(): array
GitTagCmd::getName() => GitTagCmd::aliases(),
GitLogCmd::getName() => GitLogCmd::aliases(),
GitEmojiCmd::getName() => GitEmojiCmd::aliases(),
ChangelogCmd::getName() => ChangelogCmd::aliases(),
AddCommitCmd::getName() => AddCommitCmd::aliases(),
AddCommitPushCmd::getName() => AddCommitPushCmd::aliases(),
];
Expand All @@ -117,6 +109,7 @@ protected function subCommands(): array
GitEmojiCmd::class,
AddCommitCmd::class,
AddCommitPushCmd::class,
ChangelogCmd::class,
];
}

Expand Down Expand Up @@ -495,180 +488,4 @@ public function tagDeleteCommand(FlagsParser $fs, Output $output): void
$cmd->run($fs->getFlags());
}

/**
* collect git change log information by `git log`
*
* @arguments
* oldVersion string;The old version. eg: v1.0.2
* - keywords `last/latest` will auto use latest tag.
* - keywords `prev/previous` will auto use previous tag.;required
* newVersion string;The new version. eg: v1.2.3
* - keywords `head` will use `Head` commit.;required
*
* @options
* --exclude Exclude contains given sub-string. multi by comma split.
* --fetch-tags bool;Update repo tags list by `git fetch --tags`
* --file Export changelog message to file
* --filters Apply built in log filters. multi by `|` split. TODO
* allow:
* kw keyword filter. eg: `kw:tom`
* kws keywords filter.
* ml msg length filter.
* wl word length filter.
* --format The git log option `--pretty` value.
* can be one of oneline, short, medium, full, fuller, reference, email,
* raw, format:<string> and tformat:<string>.
* -s, --style The style for generate for changelog.
* allow: markdown(<cyan>default</cyan>), simple, gh-release(ghr)
* --repo-url The git repo URL address. eg: https://github.com/inhere/kite
* default will auto use current git origin remote url
* --nm,--no-merges bool;No contains merge request logs
* --unshallow bool;Convert to a complete warehouse, useful on GitHub Action.
* --with-author bool;Display commit author name
* --cb, --to-clipboard bool;Copy results to clipboard
*
* @param FlagsParser $fs
* @param Output $output
*
* @example
* {binWithCmd} last head
* {binWithCmd} last head --style gh-release --no-merges
* {binWithCmd} v2.0.9 v2.0.10 --no-merges --style gh-release --exclude "cs-fixer,format codes"
*/
public function changelogCommand(FlagsParser $fs, Output $output): void
{
// see https://devhints.io/git-log-format
// useful options:
// --no-merges
// --glob=<glob-pattern>
// --exclude=<glob-pattern>

$repo = Repo::new();
if ($fs->getOpt('fetch-tags')) {
$fetch = $repo->newCmd('fetch', '--tags');
// fix: fetch tags history error on github action.
// see https://stackoverflow.com/questions/4916492/git-describe-fails-with-fatal-no-names-found-cannot-describe-anything
$fetch->addIf('--unshallow', $fs->getOpt('unshallow'));
$fetch->addArgs('--force');
$fetch->runAndPrint();
}

$builder = $repo->newCmd('log');

// git log v1.0.7...v1.0.8 --pretty=format:'<project>/commit/%H %s' --reverse
// git log v1.0.7...v1.0.7 --pretty=format:'<li> <a href="https://github.com/inhere/<project>/commit/%H">view commit &bull;</a> %s</li> ' --reverse
// git log v1.0.7...HEAD --pretty=format:'<li> <a href="https://github.com/inhere/<project>/commit/%H">view commit &bull;</a> %s</li> ' --reverse
$oldVersion = $fs->getArg('oldVersion');
$oldVersion = $this->getLogVersion($oldVersion);

$newVersion = $fs->getArg('newVersion');
$newVersion = $this->getLogVersion($newVersion);

$logFmt = GitChangeLog::LOG_FMT_HS;
if ($fs->getOpt('with-author')) {
// $logFmt = GitChangeLog::LOG_FMT_HSC;
$logFmt = GitChangeLog::LOG_FMT_HSA;
}

$output->info('collect git log output');
if ($oldVersion && $newVersion) {
$builder->add("$oldVersion...$newVersion");
}

$builder->addf('--pretty=format:"%s"', $logFmt);

// $b->addIf("--exclude $exclude", $exclude);
// $b->addIf('--abbrev-commit', $abbrevID);
$noMerges = $fs->getOpt('no-merges');
$builder->addIf('--no-merges', $noMerges);
$builder->add('--reverse');
$builder->run();

$repoUrl = $fs->getOpt('repo-url');
if (!$repoUrl) {
$rmtInfo = $repo->getRemoteInfo();
$repoUrl = $rmtInfo->getHttpUrl();
}

$output->info('repo URL: ' . $repoUrl);

if (!$gitLog = $builder->getOutput()) {
$output->warning('empty git log output, quit generate');
return;
}

$gcl = GitChangeLog::new($gitLog);
$gcl->setLogFormat($logFmt);
$gcl->setRepoUrl($repoUrl);

if ($exclude = $fs->getOpt('exclude')) {
$keywords = Str::explode($exclude, ',');
$gcl->addItemFilter(new KeywordsFilter($keywords));
}

$style = $fs->getOpt('style');
if ($style === 'ghr' || $style === 'gh-release') {
$gcl->setItemFormatter(new GithubReleaseFormatter());
} elseif ($style === 'simple') {
$gcl->setItemFormatter(new SimpleFormatter());
}

// parse and generate.
$output->info('parse logs and generate changelog');
$gcl->generate();

$outFile = $fs->getOpt('file');
$output->info('total collected changelog number: ' . $gcl->getLogCount());

if ($outFile) {
$output->info('export changelog to file: ' . $outFile);
$gcl->export($outFile);
$output->success('Completed');
} elseif ($fs->getOpt('to-clipboard')) {
$output->info('Will send results to clipboard');
Clipboard::new()->write($gcl->getChangelog());
} else {
$output->println($gcl->getChangelog());
}
}

/**
* @param string $version
*
* @return string
*/
protected function getLogVersion(string $version): string
{
$toLower = strtolower($version);
if ($toLower === 'head') {
return 'HEAD';
}

if ($toLower === 'latest' || $toLower === 'last') {
$version = $this->getDescSortedTags()->first();
$this->output->info('auto find latest tag: ' . $version);
} elseif ($toLower === 'prev' || $toLower === 'previous') {
$version = $this->getDescSortedTags()->second();
$this->output->info('auto find previous tag: ' . $version);
}

return $version;
}

/**
* @var TagsInfo|null
*/
private ?TagsInfo $tagsInfo = null;

/**
* @return TagsInfo
*/
protected function getDescSortedTags(): TagsInfo
{
if (!$this->tagsInfo) {
$this->tagsInfo = Git::new()->tag->tagsInfo('-version:refname');
}

return $this->tagsInfo;
}
}

0 comments on commit d50813f

Please sign in to comment.