跳到内容

Ansible 变更日志工具发布说明

主题

v0.31.1

发布摘要

针对 ansible-core 的 Bug 修复版本。

Bug修复

v0.31.0

发布摘要

功能发布。

次要更改

重大更改/移植指南

  • 与旧变更日志格式相关的更多内部代码已被删除。这仅可能影响其他将 antsibull-changelog 作为库使用的项目。姊妹 antsibull 项目 antsibull-build 和 antsibull-docs 可能仅在旧版本中受到影响。**antsibull-changelog CLI 工具的用户不受此更改影响**（https://github.com/ansible-community/antsibull-changelog/pull/179）。

v0.30.0

发布摘要

功能发布。

次要更改

v0.29.0

发布摘要

功能发布。

次要更改

已移除功能（之前已弃用）

Bug修复

  • 删除检查 Python >= 3.6（而不是 >= 3.9）的 Python 版本检查。此检查不是真正必要的，因为 pyproject.toml 声明了 requires-python，并且由于语法错误，旧的 Python 版本（其中 pip 不了解 requires-python）将不会加载 antsibull-changelog（https://github.com/ansible-community/antsibull-changelog/pull/167）。

v0.28.0

发布摘要

功能发布。

次要更改

v0.27.0

发布摘要

功能发布。

次要更改

v0.26.0

发布摘要

功能发布。

次要更改

v0.25.0

发布摘要

Bug 修复和功能发布。

次要更改

Bug修复

v0.24.0

发布摘要

功能发布，现在允许输出 MarkDown。

次要更改

已弃用功能

v0.23.0

版本摘要

功能发布。

次要更改

v0.22.0

版本摘要

新功能发布

次要更改

v0.21.0

版本摘要

包含弃用项的维护版本。

已弃用功能

v0.20.0

版本摘要

使用新构建系统的 Bug 修复和维护版本。

重大更改

Bug 修复

v0.19.0

版本摘要

功能发布。

次要更改

v0.18.0

版本摘要

放弃对旧 Python 版本支持的维护版本。

重大更改/移植指南

v0.17.0

版本摘要

ansible-core 的功能发布。

次要更改

v0.16.0

版本摘要

功能和 Bug 修复版本。

次要更改

Bug 修复

v0.15.0

版本摘要

功能发布。

次要更改

v0.14.0

版本摘要

通过 ansible-core 2.13 加快发布过程的功能发布。

次要更改

v0.13.0

版本摘要

此版本使变更日志构建更加可靠。

次要更改

Bug 修复

v0.12.0

版本摘要

支持 ansible-core 和 Ansible 集合以外的其他项目的新功能发布。

次要更改

Bug 修复

  • 当为 ansible-core 将 use_semantic_versioning 设置为 true 时，修复预发布折叠的问题。

v0.11.0

次要更改

  • 当使用 ansible-core 2.11 或更新版本时，现在将检测带有参数规范的新角色。我们只考虑角色的 main 入口点。

Bug 修复

  • 当在 ansible-base/ansible-core 中使用 modules 的子目录时，如果未使用 --use-ansible-doc，则会将错误的模块名称传递给 ansible-doc。

v0.10.0

次要更改

  • antsibull-changelog release 的新 --cummulative-release 选项允许将自上次发布版本（或如果没有上次发布版本，则为祖先版本）之后且最迟为当前发布版本的所有插件和对象添加到发布中。这对于 community.general 和类似组织的集合的主要发布是必需的。
  • 现在，当进行发布时，如果未出现 prelude_section_name 部分（默认值：release_summary），则会打印警告。

Bug 修复

  • 确保 ansible-base/-core 内部的插件缓存在不使用 --use-ansible-doc 的情况下工作。

v0.9.0

重大更改

  • 添加了对报告集合中的新剧本和角色的支持。
  • 添加了对特殊变更日志片段部分的支持，这些部分会将新插件和/或对象添加到此版本的变更日志中。这主要对 test 和 filter 插件，以及对 playbook 和 role 对象有用，这些对象尚未自动检测到并在 changelogs/changelog.yaml 或生成的 RST 变更日志中提及。

这些部分的格式及其内容如下

---
add plugin.filter:
  - name: to_time_unit
    description: Converts a time expression to a given unit
  - name: to_seconds
    description: Converts a time expression to seconds
add object.role:
  - name: nginx
    description: The most awesome nginx installation role ever
add object.playbook:
  - name: wipe_server
    description: Totally wipes a server

对于每个条目，都会添加给定类型的插件（add plugin.xxx 部分）或对象（add object.xxx 部分）列表（插件的类型为 filter、test，对象的类型为 playbook、role）。每个插件或对象都有一个短名称和一个简短的描述。这些字段对应于模块/插件的名称以及模块和可文档化插件的 DOCUMENTATION 块中的 short_description 字段。

小的改动

  • 为 antsibull-changelog release 添加 --update-existing 选项，该选项允许更新当前版本的发布日期和（如果相关）代号，而不是简单地报告版本已存在。

重大更改/移植指南

  • 新的选项 prevent_known_fragments，其默认值是 keep_fragments 的值，允许控制是否忽略过去已出现过的名称的片段。如果 keep_fragments=false，则会发生新的行为，这对用户来说不那么令人惊讶（请参阅 https://github.com/ansible-community/antsibull-changelog/issues/46）。像 ansible-base/ansible-core changelog 这样使用 keep_fragments=true 的变更日志不受影响。

v0.8.1

错误修复

  • 修复了使用 trivial 部分生成变更日志时的错误。

v0.8.0

小的改动

  • 允许在使用 API 时不保存发布时的变更日志。
  • 允许在加载/保存时清理变更日志数据。这意味着未知的将信息会被删除，错误的信息会被剥离。这将在新创建的变更日志配置中启用，但为了向后兼容性而禁用。

v0.7.0

小的改动

  • 新的配置选项 ignore_other_fragment_extensions 允许配置是否只使用 .yaml 和 .yml 文件（正如 ansible-test sanity --test changelog 测试所规定的那样）。现有配置的默认值为 false，新配置的默认值为 true。
  • 允许使用语义版本控制，也可通过 use_semantic_versioning 配置设置用于 Ansible-base。
  • 重构了变更日志生成代码，以在变更日志条目中提供所有序言（发布摘要），并提供通用功能来提取分组的版本列表。这些更改主要用于 antsibull 项目。

v0.6.0

小的改动

  • 新的变更日志配置默认将 CHANGELOG.rst 文件放置在顶层目录中，而不是在 changelogs/ 中。
  • 当 keep_fragments 设置为 false 时，配置选项 archive_path_template 允许将片段移动到归档目录中。
  • 选项 use_fqcn （在新配置中设置为 true）允许对新的插件和模块使用 FQCN。

v0.5.0

小的改动

  • 内部变更日志生成器代码变得更加灵活，以帮助 antsibull 生成 Ansible 移植指南。

v0.4.0

小的改动

  • 允许通过 config.yaml 启用或禁用扁平映射。

错误修复

  • 修复了当集合符号链接到 Ansible 的集合搜索路径中时，错误的模块命名空间检测。这还允许将发布添加到 Ansible 无法找到的集合中。

v0.3.1

错误修复

  • 当 changelogs/fragments 不存在时，不会失败。在这种情况下，只需假设没有片段即可。
  • 改进了当 changelogs/config.yaml 不是字典或不包含 sections 时的行为。
  • 改进了当指定 --is-collection 且找不到 changelogs/config.yaml 时，或使用 lint 子命令时的错误消息。

v0.3.0

小的改动

  • 允许通过 --ansible-doc-bin 传递 ansible-doc 二进制文件的路径。
  • 可以通过 python -m antsibull_changelog 运行变更日志生成器。
  • 在 ansible-base 检出中运行时，使用 ansible-doc 而不是 /path/to/checkout/bin/ansible-doc。

v0.2.1

错误修复

  • 允许通过指定 --use-ansible-doc 使用 ansible-doc 枚举插件/模块。

v0.2.0

小的改动

  • 添加了更多测试。
  • 修复了 ACD 变更日志生成的内部 API（变更日志的修剪和连接）。
  • 改进了错误处理。
  • 改进了当同时存在带有和不带有命名空间的新模块时，reStructuredText 的创建。
  • 改进了标题生成（删除多余的空格）。
  • 如果可用，则使用 PyYAML C 加载器/转储器。
  • lint 子命令不再需要指定是否在集合内部运行（如果通常的指标不存在）。

v0.1.0

发布摘要

作为 antsibull-changelog 的初始版本。Ansible 变更日志工具最初由 @mattclay 在 ansible/ansible 存储库中为 Ansible 本身开发。它在 felixfontein/ansible-changelog 和 ansible-community/antsibull 中进行了扩展，以处理集合，直到它被移动到当前位置 ansible-community/antsibull-changelog。