Ansible Collection Galaxy
Ansible Collection Galaxy metadata
| Type | object |
|---|---|
| File match |
galaxy.yml
|
| Schema URL | https://catalog.lintel.tools/schemas/schemastore/ansible-collection-galaxy/latest.json |
| Source | https://raw.githubusercontent.com/ansible/ansible-lint/main/src/ansiblelint/schemas/galaxy.json |
Validate with Lintel
npx @lintel/lintel check
Type:
object
https://docs.ansible.com/projects/ansible/latest/dev_guide/collections_galaxy_meta.html
Properties
authors
string[]
required
description
string
required
name
string
required
minLength=2pattern=^[a-z][a-z0-9_]+$
namespace
string
required
minLength=2pattern=^[a-z][a-z0-9_]+$
readme
string
required
The path to the Markdown (.md) readme file. This path is relative to the root of the collection. See metadata structure
version
string
required
Version must use SemVer format, which is more restrictive than PEP-440. For example 1.0.0-rc1 is valid but 1.0.0rc is not.
minLength=5pattern=^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$
build_ignore
string[]
dependencies
Record<string, string>
documentation
string
homepage
string
issues
string
license
SPDXLicense[]
license_file
string
manifest
object
A dict controlling use of manifest directives used in building the collection artifact. The key directives is a list of MANIFEST.in style directives The key omit_default_directives is a boolean that controls whether the default directives are used. Mutually exclusive with build_ignore.
2 nested properties
directives
string[]
omit_default_directives
boolean
repository
string
tags
string[]
Definitions
CollectionVersionConstraintModel
string
SPDXLicense
enum
An enumeration.
SPDXLicenseEnum
enum
An enumeration.
Examples
"galaxy.yml"