跳转到内容

galaxy

此规则识别galaxy.yml中提到的集合版本是否理想，即版本号是否大于或等于1.0.0。

此规则在预期位置查找变更日志文件，详细信息如下面的“变更日志详细信息”部分所述。

此规则检查galaxy.yml文件是否包含Automation Hub认证所需的标签之一。可以添加其他自定义标签，但必须存在一个或多个这些标签才能获得认证。

标签列表如下：application、cloud、database、infrastructure、linux、monitoring、networking、security、storage、tools、windows。

此规则可能会产生如下消息

  • galaxy[version-missing] - galaxy.yaml应包含版本标签。
  • galaxy[version-incorrect] - 集合版本应大于或等于1.0.0
  • galaxy[no-changelog] - 集合缺少预期位置的变更日志文件。
  • galaxy[no-runtime] - 请添加meta/runtime.yml文件。
  • galaxy[tags] - galaxy.yaml必须包含以下必需标签之一：application、cloud、database、infrastructure、linux、monitoring、networking、security、storage、tools、windows。
  • galaxy[tags-format] - galaxy.yal标签必须正确格式化，符合正则表达式。
  • galaxy[tags-length] - galaxy.yml标签字符数不能超过64个字符。
  • galaxy[tags-count] - galaxy.yml标签数量不能超过20个。
  • galaxy[invalid-dependency-version] = 无效的集合元数据。依赖项版本规范范围无效。

如果要忽略上述某些消息，可以将它们添加到ignore_list中。

问题代码

# galaxy.yml
---
name: foo
namespace: bar
version: 0.2.3 # <-- collection version should be >= 1.0.0
authors:
  - John
readme: ../README.md
description: "..."

正确代码

# galaxy.yml
---
name: foo
namespace: bar
version: 1.0.0
authors:
  - John
readme: ../README.md
description: "..."

变更日志详细信息

此规则需要在集合根目录中找到CHANGELOG.md、CHANGELOG.rst、changelogs/changelog.yaml或changelogs/changelog.yml文件。

如果存在changelogs/changelog.yaml或changelogs/changelog.yml文件，则将检查其架构。

最低要求的changelog.yaml/changelog.yml文件

# changelog.yaml
---
releases: {}

必需标签详细信息

问题代码

# galaxy.yml
---
namespace: bar
name: foo
version: 1.0.0
authors:
  - John
readme: ../README.md
description: "..."
license:
  - Apache-2.0
repository: https://github.com/ORG/REPO_NAME

正确代码

# galaxy.yml
---
namespace: bar
name: foo
version: 1.0.0
authors:
  - John
readme: ../README.md
description: "..."
license:
  - Apache-2.0
repository: https://github.com/ORG/REPO_NAME
tags: [networking, test_tag, test_tag_2]