summaryrefslogtreecommitdiffstats
path: root/src/ansiblelint/rules/meta_incorrect.md
diff options
context:
space:
mode:
Diffstat (limited to 'src/ansiblelint/rules/meta_incorrect.md')
-rw-r--r--src/ansiblelint/rules/meta_incorrect.md32
1 files changed, 32 insertions, 0 deletions
diff --git a/src/ansiblelint/rules/meta_incorrect.md b/src/ansiblelint/rules/meta_incorrect.md
new file mode 100644
index 0000000..b1e8793
--- /dev/null
+++ b/src/ansiblelint/rules/meta_incorrect.md
@@ -0,0 +1,32 @@
+# meta-incorrect
+
+This rule checks role metadata for fields with undefined or default values.
+Always set appropriate values for the following metadata fields in the `meta/main.yml` file:
+
+- `author`
+- `description`
+- `company`
+- `license`
+
+## Problematic Code
+
+```yaml
+---
+# Metadata fields for the role contain default values.
+galaxy_info:
+ author: your name
+ description: your role description
+ company: your company (optional)
+ license: license (GPL-2.0-or-later, MIT, etc)
+```
+
+## Correct Code
+
+```yaml
+---
+galaxy_info:
+ author: Leroy Jenkins
+ description: This role will set you free.
+ company: Red Hat
+ license: Apache
+```