punch.py 2.0.0

关于punch

Punch是一个可配置的版本更新器，您可以使用它来自动管理项目版本号。

Punch将其项目的版本存储在其自己的文件中。每次您需要更新它时，Punch都会运行配置的文件，并将旧版本替换为新版本。此外，Punch还可以自动将版本更改提交到您选择的VCS。

该项目受到了 bumpversion 的极大启发，我想感谢该项目作者Filip Noetzel的工作和启发性的想法。

安装

Punch通过pip在Python 2和Python 3中均可用。只需创建一个虚拟环境并运行

pip install punch.py

要开始使用Punch，您需要一个配置文件和一个版本文件。您可以使用标志 --init 让Punch为您创建这两个文件，该标志将创建当前目录中的 punch_config.py 和 punch_version.py 文件。

punch --init

which will create the punch_config.py and punch_version.py files in the current directory.

贡献

请参阅CONTRIBUTING文件以获取详细信息。请记住，该项目在 develop 分支中积极开发，因此如果您尝试实现新功能或修复错误，请务必在那里工作。

2.0.0 (2019-11-21)

• 弃用 Punch 不再支持在 FILES 变量中使用 GLOBAL 变量。现在分配给 FILES 部分字段的值是简单的字符串，不再通过 Jinja2 处理。

• Python 2.x 的初始弃用：CI 流程不再测试 Python2.x。

• 文档的全面审查：文档已拆分为多个文件，以便更容易查找信息和理解程序。

• 测试自动文档的初始实现。现在可以解析集成测试以提取文档的示例。[见文档：来自测试的示例]

• 命名序列化器：现在可以通过字典语法为序列化器分配名称。此更改使得选择用于 VCS 的序列化器成为可能。[见文档：配置 > GLOBALS]

• 复杂序列化器：标准序列化器在搜索和替换操作中使用相同的模式。使用复杂序列化器，您可以定义两个不同的模式，每个操作一个。[见文档：高级配置 > 复杂序列化器]

• 每个由 Punch 管理的文件的配置可以覆盖全局序列化器或添加新的序列化器。[见文档：配置 > FILES]

• 发行说明：Punch 可以配置为检查基于新版本的模式是否存在于管理的文件中。这使得检查 HISTORY 文件是否已更新变得简单，而无需中断程序的执行并在以后恢复它。[见文档：高级配置 > 发行说明]

1.6.2 (2019-08-22)

• 更新 HISTORY 文件，并考虑现在提出一个解决方案以处理更新版本时需要手动干预的文件。

1.6.1 (2019-08-22)

• 合并 PR#38：修复了标准注释消息的行为

1.6.0 (2019-04-12)

• 合并 PR #37：添加了 –quiet 选项以抑制所有警告

• 添加了 –simulate 选项的 VCS 信息

• 测试更新以使用最新的 pytest 功能和删除已弃用的功能

• 修复了 requirements 设置（development.txt 现在继承 testing.txt）

• 内部结构改进，以简化新功能（如增强操作）的开发

1.5.0 (2018-05-03)

• 修复了 issue #31：Punch 不添加文件到提交 + 使文件添加可配置

• 修复了 issue #34 的一部分：[git VCS] 额外的分支选项（由 joshua-s 提供）

• 添加了 ‘include_files’ 和 ‘include_all_files’ 标志（issue #31）

• 添加了 ‘target_branch’ 标志（issue #34）

1.4.5 (2018-04-20)

• 在 CLI 中使用 version.to_file（PR#33 由 gthank 提供）

1.4.4 (2018-04-18)

• 修复了 DateVersionPart 的错误行为（PR#32 由 gthank 提供）

1.4.3 (2018-03-21)

• 修复了 issue #23：当在受控文件中找不到匹配项时打印警告

• 修复了 issue #27：文档中可能的错别字

• 修复了 issue #29：punch 无声地添加和提交与 git 无关的未跟踪文件

1.4.2 (2017-10-05)

• 修复了月份和以 0 结尾的日期的错误

1.4.1 (2017-09-16)

• 日期部分表示的细微调整

1.4.0 (2017-06-07)

• 支持操作指定复杂行为

• PEP8 合规性全局审查

1.3.2 (2017-03-29)

• 修复了 Windows 上的 CLI 脚本安装（由 jobec 提供）

1.3.1 (2017-01-23)

• 在 README 中添加了 Readthedocs 文档链接

1.3.0 (2017-01-20)

• 添加了数据库名称版本部分（支持 CalVer 语法）

1.2.0 (2016-09-09)

• Michele D’Amico 添加了 Mercurial 支持

1.1.2 (2016-06-09)

• 修复了 issue #7

1.1.1 (2016-06-01)

• 修复了 issue #3、#4、#5

1.1.0 (2016-05-26)

• 添加了 –set-part 和 –reset-on-set 标志

1.0.2 (2016-05-24)

• 修复了文档中的 PyPI 徽章

• 在文档和测试套件中添加了一些示例

1.0.1 (2016-05-21)

• 由于名称冲突，在 PyPI 上更改软件包名称的最后一刻。

1.0.0 (2016-05-19)

• PyPI 上的首次发布。