carthorse 1.4.0

TOML配置

您的文件应包含以下部分

[tool.carthorse]
version-from = "poetry"
tag-format = "v{version}"
when = [
  "version-not-tagged"
]
actions = [
   { run="poetry publish --build"},
   { name="create-tag"},
]

此设计旨在将其包含为pyproject.toml文件的一部分。

YAML配置

您的文件应包含以下部分

carthorse:
  version-from: poetry
  tag-format: v{version}
  when:
    - version-not-tagged
  actions:
    - run: "poetry publish --build"
    - create-tag

它做什么？

大致来说

• 从项目的源代码中提取项目的版本。

• 根据版本格式化标签

• 执行一系列检查，如果其中任何一项失败，则停止。

• 执行您指定的任何操作。

版本提取

目前支持以下几种方法从项目提取版本

setup.py

这将运行python setup.py --version并使用返回的版本。

poetry

这将解析项目的pyproject.toml并使用tool.poetry.version键作为项目的版本。

flit

这将从flit风格的__version__中提取版本，而不导入包。例如，如果您的模块名为foobar，这将检查foobar/__init__.py或foobar.py。该配置如下

[tool.carthorse]
version-from = { name="flit", module="foobar" }

文件

这将从指定的文件中提取版本。默认情况下，这将是从整个文件中剥离的内容，但也可以指定一个模式。这可以用来从不执行它的< span class="docutils literal">setup.py中提取版本。配置会是

[tool.carthorse]
version-from = { name="file", path="setup.py", pattern="version='(?P<version>[^']+)" }

无

这将返回一个空字符串作为版本。如果你使用carthorse作为管理git标签或时间戳发布的工具，这很有用。

环境变量

这将从指定的环境变量中提取版本。例如，如果你在$VERSION中构建了版本，你可以使用以下方法提取它

[tool.carthorse]
version-from = { name="env" }

如果你需要从具有不同名称的环境变量中提取，例如$MYVERSION，你可以使用以下方法提取它

[tool.carthorse]
version-from = { name="env", variable="MYVERSION" }

标签格式化

tag-format配置选项允许你通过指定一个python格式字符串来控制版本标签的格式，其中版本将被插入。默认是v{version}。

在此可用的名称是

version

版本提取返回的版本。

now

当前日期和时间的python datetime。

执行检查

when配置部分的每个检查都将按顺序执行。如果有任何失败，则不会执行任何操作。

目前可用的检查有

version_not_tagged

如果从项目中提取的版本没有当前的git标签，这将通过。

never

这是一个安全网和测试助手，这个检查永远不会通过。

always

如果你基本上想跳过检查阶段，这很有用。

操作

如果所有检查都通过，则按顺序执行列出的操作。如果在执行操作期间发生错误，则不会执行进一步的操作。

目前可用的操作有

run

在shell中运行指定的命令。将传递完整的环境，并且$TAG将包含从标签格式计算出的标签。

create_tag

这将基于提取的版本创建一个git标签，并将其推送到指定的远程。默认情况下，使用origin远程。

如果你使用carthorse管理按环境标签，例如，你可以要求更新现有标签，如下所示

[tool.carthorse]
actions = [
   { name="create-tag", update=true},
]

变更