collective.releaser 0.7.1

设置您的环境

要顺畅地使用 zc.buildout，首先需要在环境中设置一些适用于任何基于 Buildout 的应用程序的全局设置。

在您的家目录中放置两个文件

• HOME/.buildout/.httpauth：此文件将包含系统尝试访问受密码保护的 http(s) 资源（如 svn 服务器或私人网站）时的认证信息。它是一个文本文件，其中每行是：realm,url,user,password

  例如

  trac,https://svn.ingeniweb.com,user,password
  pypi,http://products.ingeniweb.com,user,password

  此文件被 lovely.buildouthttp 使用。

• HOME/.buildout/default.cfg：此文件设置了一些默认值，以便 Buildout 可以缓存和节省下载的 egg。

  例如

  [buildout]
  download-cache = /home/tarek/.buildout/downloads
  eggs-directory = /home/tarek/.buildout/eggs

接下来，您需要确保可以将 egg 发布到多个目标，因为您可能希望某些私有 egg 不要发布到 PyPI。在此阶段，唯一提供与 PyPI 相同 Web 服务的软件是 Plone Software Center >= 1.5。

为了能够处理多个类似 PyPI 的服务器，我们需要安装一个名为 collective.dist 的小插件

$ easy_install collective.dist

这将允许您在 ~/.pypirc 文件中定义多个服务器。例如，如果您正在使用一个私有的类似 PyPI 的服务器，您可以在 HOME/.pypirc 中定义它如下：

[distutils]
index-servers =
    pypi
    ingeniweb-public

[pypi]
username:ingeniweb
password:secret

[ingeniweb-public]
repository:http://products.ingeniweb.com/catalog
username:ingeniweb
password:secret

最后，您需要定义发布策略配置，这将定义每个目标服务器上必须发布的包列表（正则表达式）以及与 setup.py 一起使用的命令序列。以下是一个默认示例，可以添加到您的 .pypirc 中，通过完成 release-command 和 release-packages 变量来完善部分：

...

[ingeniweb-public]
...
release-command = mregister sdist build_mo bdist_egg mupload
release-packages =
    ^iw\..*

[pypi]
...
release-command = mregister sdist build_mo bdist_egg mupload
release-packages =
    ^plone\..*
    ^collective\..*

这将推送所有以 plone. 或 collective. 开头的 egg 到 PyPI，并将所有以 iw. 开头的 egg 推送到 ingeniweb-public。推送包的命令由 command 定义。

创建项目结构

每个项目都必须以相同的方式进行结构化

$ paster create -t releaser_project my_project

这将询问您一些值

• project_name：项目的名称

• project_repo：subversion 仓库的根目录

• 一些可以保留为默认值的更多值。

这将生成 my_project 中的文件夹集

$ ls my_project
./buildout
./bundles
./docs
./packages
./releases

每个文件夹都有其作用

• buildout：包含 buildout 配置文件

• bundles：包含用于开发模式工作的包

• docs：包含有关项目的文档

• packages：包含基于 egg 的包

• releases：包含 buildout 的发布版本

此结构必须在子版本控制系统中提交

$ svn import my_project http://some.svn/my_project -m "initial commit"

之后，您就可以在您的构建环境中工作了。

创建基于egg的包

从那里，您可以通过将它们放入 packages 文件夹，并使用 ZopeSkel 中的任何模板，将一些包添加到项目中。

不过请注意，每个项目都必须在包中使用 trunk/tags/branches 结构。

$ cd my_projet/packages
$ paster create -t plone plone.example
$ package_svn_prepare plone.example

最后一个命令只是执行以下操作

$ mv plone.example plone.example_md5_of_plone.example
$ mkdir plone.example
$ mkdir plone.example/tags plone.example/branches
$ mv plone.example_md5_of_plone.example plone.example/trunk
$ svn add plone.example
$ svn ci -m "initial import of  plone.example"

请勿在 paster 中使用 trunk 作为包名，因为这将在包中生成不良元数据。

可以在 setup.cfg 中添加一个特殊部分，以便在每次发布包时发送邮件

[mail_hook]
hook = collective.releaser:mail
from = support@ingeniweb.com
emails =
     trac@lists.ingeniweb.com

如果您的系统没有 SMTP 服务器，您需要在您的 .pypirc 文件中添加 SMTP 服务器的名称及其端口号，在 mail_hook 部分中

[mail_hook]
host = smtp.neuf.fr
port = 25

从那里，您可以使用开发变量将包绑定到您的构建环境中，在您的 my_project/buildout 文件夹中

[buildout]
...
develop=
    .../packages/monprojet.reports/trunk

同样，bundle 文件夹也可以用来设置 svn:externals，以便在构建环境中工作更加简单。

发布egg

通过在包中调用 release 来发布 eggs

$ python setup.py release
running release
This package is version 0.1.2
Do you want to run tests before releasing ? [y/N]: N
Do you want to create the release ? If no, you will just be able to deploy again the current release [y/N]: Y
Enter a version [0.1.2]: 0.1.2
Commiting changes...
Creating branches...
...

这将处理以下操作

• 升级 setup.py 版本

• 在 svn 中创建分支和标签

• 将包推送到各种类似 PyPI 的服务器

• 如果 setup.cfg 中提供了 mail_hook 部分，将发送包含更改的邮件

如果要从非 svn 文件夹发布包，则使用此命令来禁用特定的 svn 钩子

$ python setup.py release --pre-hook --post-hook

您也可以使用一些参数来避免命令行提示

$ python setup.py release -a --version=0.1.3

发布项目

发布项目包括调用 project_release 然后调用 project_deploy。

project_release 只会在子版本控制中创建一个新的分支

$ cd my_project/buildout
$ project_release --no-archive --version=0.1

这将把 my_project/buildout 复制到子版本控制中的 my_project/releases/0.1。然后您可以在这次发布中工作，以确定构建环境中的版本。一个好的做法是为部署创建一个专门的 cfg 文件。

下一步是使用 project_deploy 生成一个 tarball

$ cd /tmp
$ svn co http://somesvn/my_projet/releases/0.1 my_project
$ cd my_project
$ project_deploy prod.cfg

这将使用 VirtualEnv 在 /tmp 中构建一个 tarball，并设置一切以便可以在任何离线位置使用此存档重新安装构建环境。

生成的发布可以通过两行命令安装

$ python boostrap.py
$ bin/buildout

升级现有buildout

要升级现有的构建环境，您可以使用 project_release 命令。它将创建一个包含运行项目所需的全部 eggs 和 .cfg 文件的 tarball。

在您的构建环境中运行它，通过指向 .cfg 文件并提供一个存档的名称

$ cd my_project/buildout
$ project_release --version=0.2

这将发布在 dev.cfg 中找到的所有开发 eggs。如果您的 dev.cfg 看起来像

[buildout]
parts = eggs
develop =
  ../my.package
  ../my.other

[eggs]
recipe = zc.recipe.egg
eggs =
  my.package
  my.other

那么 my.package 和 my.other 将被发布，然后添加到包含所有 .cfg 文件的存档中。

如果您在 prod.cfg 中有一个静态版本

[buildout]
parts = eggs
versions = versions

[versions]
my.package = 0.1

[eggs]
recipe = zc.recipe.egg
eggs =
  my.package
  my.other

那么只有 my.other 将被发布，但两者都添加到存档中。

存档的默认配置文件（例如：buildout.cfg）将看起来像这样

[buildout]
extends = prod.cfg
versions = versions

[versions]
my.package=0.1
my.other=0.2

所以您可以直接在您的生产服务器上运行 ./bin/buildout 来使用正确的包版本。