yaml4rst 0.1.6

用法

此程序的典型用例是改进Ansible角色的默认YAML文件。

推荐的执行此操作的方法是将角色存储库中的所有更改提交到存储库，然后从角色存储库的根目录运行

yaml4rst -e 'ansible_full_role_name=ROLE_OWNER.ROLE_NAME' defaults/main.yml -i

确保将ROLE_OWNER.ROLE_NAME替换为特定的Ansible角色名称。

这将检查并原地重新格式化defaults/main.yml文件。

现在您可以使用您选择的比较/编辑工具检查重新格式化的文件，并修复yaml4rst可能产生的任何警告。

有关自动测试的输入和输出文件的示例，请参考测试目录中的input_files和output_files。

请注意，由于yaml4rst已安装，因此yaml4rst是从debops-optimize调用的，因此您可能想要尝试debops-optimize。

功能

检查以下内容

• 合理的变量命名空间

• 未记录的变量

自动修复

• 不是折叠的RST部分

• 未记录的变量（为用户添加FIXME）

• 未折叠的已记录变量

• 没有定义标题的YAML文档

• 变量和部分之间的间距

已知限制

• 不处理具有隐含级别和缺少关闭折叠标记的折叠。

  状态：应该可行，但当前不需要也不实现。抛出一个NotImplementedError异常，导致CLI程序立即以错误和对此部分的引用终止。

  作为解决方案，只需使用您喜欢的编辑器删除打开的折叠，因为yaml4rst仍将为部分和变量添加缺少的折叠。请参阅Makefile（prepare-real-data目标），其中使用了此类解决方案进行集成测试。请注意，这并不完美，如debops.apt_install测试用例所示。

存储库

• GitHub（主要存储库，带有问题跟踪器）

文档

• Read the Docs

作者

• Robin Schneider

许可证

GNU Affero通用公共许可证v3（AGPL-3.0）