summaryrefslogtreecommitdiffstats
path: root/src/ansiblelint/rules/meta_incorrect.md
blob: b1e8793d72aa562eaeab46bdc31a7db912d65473 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
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
```