README

Brancho 是一个工具，可以帮助您按照定义的命名约定创建分支。它还可以提交您的更改。

安装

建议您全局安装 Brancho

composer global require spryker-sdk/brancho

如果您想在项目中使用 Brancho，请进入项目文件夹并运行

composer require spryker-sdk/brancho --dev

将 brancho 添加到可执行路径

export PATH=/path/to/vendor/bin

在 Ubuntu 20.04 上，路径应该是 ~/.config/composer/vendor/bin

配置

安装后，您需要配置 Brancho。默认配置文件名为 .brancho。您基本上只需要定义应使用的解析器。

resolver: \Full\Qualified\ClassName

您也可以在此处配置过滤器，或将所需的过滤器添加到解析器中。

此外，您可以有一个 .brancho.local 文件，它只包含您需要的配置，例如凭据。

命令

Brancho 提供以下命令

brancho branch - 创建分支。
brancho commit - 提交更改。

您可以使用 -h 参数对这两个命令获取更多信息。

命令别名

您应该为这两个命令创建别名，以便更容易使用。

示例

alias bb=brancho branch
alias bc=brancho commit
alias bca=brancho commit -a

解析器

解析器用于解析分支名称。解析器可以从任何地方接收信息。要构建自己的解析器，您需要实现 \Brancho\Resolver\ResolverInterface。您将能够访问

\Symfony\Component\Console\Input\InputInterface
\Symfony\Component\Console\Output\OutputInterface
\Brancho\Context\ContextInterface

Symfony 的接口可以用来检索输入数据或请求用户输入。有关更多信息，请参阅 Symfony 文档。

通过 \Brancho\Context\ContextInterface，您可以访问配置和配置的过滤器。

过滤器

过滤器用于将用户输入过滤成规范格式。例如，用户输入可能来自某个地方，例如一个问题名称或简短描述。通常这些包含空格和大小写字母，这在 Git 分支名称中是不允许的。

获取 Jira API 令牌

访问 https://id.atlassian.com/manage-profile/security/api-tokens 并创建一个新的 API 令牌。

示例配置

resolver: \Brancho\Resolver\JiraResolver
filters:
    - \Brancho\Filter\Slugify
jira:
    host: https://spryker.atlassian.net/
    username: foo.bar@spryker.com
    password: {YOUR-API-TOKEN}

spryker-sdk / brancho

维护者

详细信息

README

安装

将 brancho 添加到可执行路径

配置

命令

命令别名

解析器

过滤器

获取 Jira API 令牌

示例配置