跳转到主要内容

用于处理Ansible文档标记的Python库

项目描述

antsibull-docs-parser - Python库,用于处理Ansible文档标记

Discuss on Matrix at #antsibull:ansible.com Nox badge Codecov badge REUSE status

这是一个用于处理Ansible文档标记的Python库。它以antsibull-docs命名,该代码源自该地址。将其移出是为了使其他项目中重用标记代码变得更加容易,而无需依赖于antsibull-docs的所有依赖项。

开发

安装并运行nox以运行所有测试。nox将在检出项目的.nox目录中创建虚拟环境,并安装运行测试所需的依赖项。

要运行特定测试

  1. nox -e test仅运行单元测试;
  2. nox -e lint一次性运行所有代码检查器和格式化工具;
  3. nox -e formatters运行isortblack
  4. nox -e codeqa运行flake8pylintreuse lintantsibull-changelog lint
  5. nox -e typing运行mypypyre
  6. nox -e create_vectors更新test-vectors.yml文件。请注意,该文件应与antsibull-docs-ts项目中的对应文件同步。

发布新版本

  1. 运行nox -e bump -- <版本> <发布摘要信息>。这将
    • src/antsibull_docs_parser/__init__.py中提升包版本。
    • 创建包含release_summary部分的changelogs/fragments/<版本>.yml
    • 运行antsibull-changelog release并将更改的文件添加到git中。
    • 提交消息为发布 <版本>并运行git tag -a -m 'antsibull-docs-parser <版本>' <版本>
    • 运行hatch build --clean
  2. 运行git push到适当的远程仓库。
  3. 一旦GitHub上的CI通过,运行nox -e publish。这将
    • 运行hatch publish
    • 将版本提升到<版本>.post0
    • 将更改的文件添加到git中并运行git commit -m '发布后版本提升.'
  4. git push --follow-tags运行到适当的远程仓库并创建GitHub发布。

项目详细信息


下载文件

下载适用于您的平台的文件。如果您不确定选择哪个,请了解有关安装包的更多信息。

源分发

antsibull_docs_parser-1.1.0.tar.gz (55.2 kB 查看散列)

上传时间

构建分发

antsibull_docs_parser-1.1.0-py3-none-any.whl (33.8 kB 查看散列)

上传时间 Python 3

由以下支持