YAML indentation for change types differs from examples and expected indentation

[alisonlhart]

Under each change type section in the generated changelog.yml - bugfixes, major_changes, minor_changes, breaking_changes, etc - the list of changes are placed at the same hierarchical level as the change type title.

For example, in the changelog.yaml example here, the spacing is shown to be:

releases:
  1.0.0:
    release_date: '2020-04-01'
    codename: White Rabbit
    changes:
      release_summary: This is the initial White Rabbit release. Enjoy!
      major_changes:
        - The authentication method handling has been rewritten.   # Two spaces indented from `major changes`

In the actual generated changelog.yaml, all fragment details listed appear to be placed at the same indentation level as the change type.

For example:

releases:
  1.0.0:
    release_date: '2020-04-01'
    codename: White Rabbit
    changes:
      release_summary: This is the initial White Rabbit release. Enjoy!
      major_changes:
      - The authentication method handling has been rewritten.   # No indention from `major changes`

No config.yml setting seems to have an affect on this behavior. If there's a way to prevent this behavior in the config or if this is intentional, feel free to close out this issue!

[felixfontein]

The format used is the default output format used by PyYAML. There's no way to prevent the current behavior via configuration (if someone wants to change that, I'll happily review + merge PRs that do it in a backwards compatible way) except by reformatting the generated YAML file after it has been written by antsibull-changelog (prettier can reformat YAML files IIRC, then there's yamlfmt, and there are likely many more programs which can do that).

The examples in https://github.com/ansible-community/antsibull-changelog/blob/main/docs/changelog.yaml-format.md#release-information are semantically equivalent (as YAML files) to what the program writes, but not syntactically equivalent.

[alisonlhart]

@felixfontein Thank you for the details!