spryker-sdk/repository-cleaner

关闭存储库中的所有开放PR，并删除除主分支外的所有现有分支

维护者

详细信息

github.com/spryker-sdk/repo-cleaner

源代码

问题

安装: 0

依赖项: 0

建议者: 0

安全: 0

星标: 0

关注者: 2

分支: 0

开放问题: 0

dev-main 2023-10-24 13:14 UTC

Requires

Requires (Dev)

proprietary 59351096338584c1a5e93a2987f78bfcde03cf04

This package is auto-updated.

Last update: 2024-09-19 06:10:21 UTC

README

U存储库清理器是一个命令行工具，旨在帮助清理由Spryker代码升级器创建的GitHub存储库中的拉取请求（PR）和分支。它提供根据指定的条件（如白名单分支和PR创建者）过滤和处理开放PR的功能。此工具特别有助于通过自动删除不必要的PR和分支来维护干净的存储库。

用法

要使用U存储库清理器，请在您的终端中执行以下命令

php bin/repoclean.php github-org repository-name whitelisted-branch1,whitelisted-branch2,whitelisted-branchN

将占位符替换为实际值

  • github-org：拥有存储库的GitHub组织或用户名。
  • repository-name：要清理的存储库名称。
  • whitelisted-branch1,whitelisted-branch2,whitelisted-branchN：逗号分隔的分支名称列表，应在处理期间列入白名单并跳过。

特性

  • 在指定的存储库中检索开放的拉取请求。
  • 基于白名单分支过滤和处理拉取请求。
  • 如果满足某些条件，则删除拉取请求及其相关分支。
  • 支持自动化存储库维护任务。

入门

  1. 将此存储库克隆到您的本地计算机。

  2. 使用Composer安装所需的依赖项。

    composer install

  3. 在config/github.php文件中配置GitHub API凭据。

  4. 使用适当的参数运行命令以清理存储库。

示例

假设您想清理由GitHub组织myorg拥有、名为my-repo的存储库，并且您想将master、main和dev分支列入白名单，您将执行以下命令

php bin/repoclean.php myorg my-repo master,main,dev

工具将处理存储库中的开放PR，跳过白名单分支，并删除不符合指定标准的任何PR。

贡献者 Pavlo Maksymov pavlo.maksymov@spryker.com Spryker SDK团队 Copilot ChatGpt

许可证

本项目受MIT许可证许可 - 有关详细信息，请参阅LICENSE文件。

请根据项目的具体细节和要求进一步自定义README描述。请确保提供有关安装、配置和使用的清晰说明。