.yamllint


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
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67

---

extends: default

yaml-files:
  # defaults
  - '*.yaml'
  - '*.yml'
  - '.yamllint'
  # match more extensions
  - '*.yaml.*'
  - '*.yml.*'

# Ideally, we should have nothing in this ignore section.
#
# Please consider removing entries below by fixing them.
ignore: |
  #### Files ####

  # Contains ruby code
  config/mail_room.yml
  generator_templates/snowplow_event_definition/event_definition.yml
  generator_templates/usage_metric_definition/metric_definition.yml

  # Has some special indentation
  doc/user/project/integrations/samples/cloudwatch.yml

  # Broken on purpose (for testing)
  spec/fixtures/lib/gitlab/metrics/dashboard/broken_yml_syntax.yml

  # Dynamic YAML files have syntax errors sometimes.
  *.erb

  # Vim temporary files.
  *.sw[pon]

  # Zipped files (by e.g. asset pipeline)
  *.gz
  *.bz2

  #### Folders ####
  node_modules/
  tmp/

# In CI some YAML files are linted using different rules.
# See `.gitlab/ci/yaml.gitlab-ci.yml`.
#
# https://gitlab.com/gitlab-org/gitlab/-/issues/385693 tracks to enable all
# rules below:
rules:
  braces:
    min-spaces-inside: 1
    max-spaces-inside: 1
    min-spaces-inside-empty: 0
    max-spaces-inside-empty: 0

  colons: disable
  comments-indentation: disable
  comments: disable
  document-start: disable
  empty-lines: disable
  indentation: disable
  key-duplicates: disable
  line-length: disable
  new-line-at-end-of-file: disable
  trailing-spaces: disable
  truthy: disable