gitctl 2.0a8

变更历史

目的

此软件包的目的是实现一个特定的工作流程，以使用Git管理由多个独立子项目组成的项目。原始动机是由zc.buildout驱动的系统，但实现不依赖于此。这不是一个100%通用的工具，但工作流程相当常见，因此也可能适用于其他用例。[dokai]

此工作流程包括使用三个预定义的分支来模拟代码的开发、预发布和生产阶段。我们假设使用一个标准中央仓库，开发人员使用它来同步他们的官方更改。该仓库被认为是标准源，并为项目提供了“官方”状态。开发人员可以自由地使用任何数量的分支、标签和仓库作为他们日常工作的部分。[dokai]

代码通常从开发流向预发布再到生产，该软件包提供工具以简化此过程。每个单独的Git仓库都使用Git提供的任何工具进行管理。

此外，该软件包提供了一个轻量级的“外部”机制，便于拉取和管理子项目。这与git-submodule提供的功能不同，因为可以定义固定和开放的依赖项。这类似于Subversion中处理外部的方式。此外，单个Git仓库不知道外部，而外部配置保存在一个单一的位置。

配置

该软件包使用两个不同的配置文件。gitctl.cfg文件提供高级配置，允许您指定如规范仓库和您的开发、预发布和生产分支的名称。gitexternals.cfg定义了项目特定配置所需的子组件。

gitctl.cfg

上游

用于引用规范仓库服务器的名称，例如“origin”。

上游URL

规范仓库服务器的地址。此地址需要指向支持推送的服务器。目前仅测试了SSH。例如：git@my.gitserver.com

分支

以换行符分隔的分支列表，这些分支将在本地仓库中进行跟踪。当为列出的每个分支克隆仓库时，将自动创建本地跟踪分支。

开发分支

开发分支的名称。上面的分支列表将隐式包含此分支。

预发布分支

预发布分支的名称。上面的分支列表将隐式包含此分支。

生产分支

生产分支的名称。上面的分支列表将隐式包含此分支。

提交邮件

提交邮件将被发送到的电子邮件地址。仅在创建新仓库时使用。

提交邮件前缀

提交邮件前缀。仅在创建新仓库时使用。

以下是一个配置示例

[gitctl]
upstream = origin
upstream-url = git@myserver.com
branches =
    development
    staging
    production
development-branch = development
staging-branch = staging
production-branch = production
commit-email = commit@myserver.com
commit-email-prefix = [GIT]

gitexternals.cfg

外部配置由一个或多个具有以下属性的节组成。每个节名称将用于命名外部将被克隆到的目录。

url（必需）

远程仓库的完整URL，例如：git@myserver.com:my.project.git

type（可选）

远程仓库的类型。目前仅支持git。

treeish（可选）

在首次克隆远程仓库时默认检出“treeish”对象的名称。该treeish对象可以引用分支或标记等。默认为master。

container（可选）

项目将被检出到的目录的名称。在此目录下将创建一个附加目录，其中包含项目文件，因此可以安全地为多个项目使用相同的值。相对路径被认为是相对于配置文件的位置。

以下是一个配置示例

[my.project]
url = git@myserver.com:my.project.git
type = git
treeish = v1.0-dev
container = src

这会将my.project.git仓库克隆到./src/my.project，并将v1.0-dev检出到工作目录。

gitctl 脚本

gitctl脚本提供子命令来实现工作流程。每个子命令都提供额外的选项。有关详细信息，请参阅gitctl [subcommand] --help。

usage: gitctl [-h] [-v] [--config CONFIG] [--externals EXTERNALS] [--verbose]
              {status,create,update,sh,branch,path,fetch,pending} ...

Git workflow utility for managing projects containing multiple git
repositories.

positional arguments:
  {status,create,update,sh,branch,path,fetch,pending}
                        Commands
    create              Initializes a new local repository and creates a
                        matching upstream repository.
    update              Updates the configured repositories by either
                        attempting a fast-forward merge on existing project
                        branches or cloning new projects.
    path                Shows the path to the project directory.
    sh                  Executes shell command for specified projects.
    status              Shows the status of each external project and alerts
                        if any are out of sync with the upstream repository.
    branch              Provides information and operates on the branches of
                        the projects.
    pending             Checks if there are any pending changes in the
                        production branches compared to the pinned down
                        versions in externals configuration.
    fetch               Updates the remote branches on all projects without
                        merging.

optional arguments:
  -h, --help            show this help message and exit
  -v, --version         show program's version number and exit
  --config CONFIG       Location of the configuration file. If omitted the
                        following locations will be search: $PWD/gitctl.cfg,
                        ~/.gitctl.cfg.
  --externals EXTERNALS
                        Location of the externals configuration file. Defaults
                        to $PWD/gitexternals.cfg
  --verbose             Prints more verbose output about repositories.

安装

使用setuptools

$ easy_install gitctl

示例

$ cd /Users/rnd/buildout/
$ gitctl path -f refactoring_these_projects
/Users/rnd/buildout/products/Project1
/Users/rnd/buildout/products/Project2
/Users/rnd/buildout/src/Project3

ProjectI
ProjectII
ProjectIII

gitctl sh -f refactoring_these_projects -c 'echo $PROJECT; git branch'

gitctl sh -f refactoring_these_projects -c 'git checkout -b my_f_branch'

gitctl sh -c 'git checkout development'
gitctl sh -f refactoring_these_projects -c 'git checkout my_f_branch'

gitctl sh -f refactoring_these_projects -c '[ `git rev-parse development` != `git rev-parse origin/production` ] && echo $PROJECT' 2> /dev/null

gitctl sh -f refactoring_these_projects -c 'git commit -m "Added newfeature"'

依赖项

• Git >= 1.6

• argparse

• GitPython == 0.1.7

贡献者

• 凯·劳塔波特，作者 [dokai]

• 罗马·苏西，[rnd]