bug: meltano.yml updates overwrite user-changed indentation

Meltano Version

2.10.0

Python Version

3.9

Bug scope

Other

Operating System

Mac OS 12.6 Monterey

Description

Steps to replicate:

1. Run meltano init test
2. cat test/meltano.yml output:

cat test/meltano.yml
version: 1
default_environment: dev
project_id: b02272c0-d17d-4512-ab23-47ed7c9133ad
environments:
- name: dev
- name: staging
- name: prod

1. Format YAML indentation differently:

version: 1
default_environment: dev
project_id: b02272c0-d17d-4512-ab23-47ed7c9133ad
environments:
  - name: dev
  - name: staging
  - name: prod

1. Run a meltano CLI command that updates meltano.yml file. In my case I ran meltano add loader target-jsonl.
2. Notice the leading indentation of the environments array members in meltano.yml has reverted from two spaces to zero:

version: 1
default_environment: dev
project_id: b02272c0-d17d-4512-ab23-47ed7c9133ad
environments:
- name: dev
- name: staging
- name: prod
plugins:
  loaders:
  - name: target-jsonl
    variant: andyh1203
    pip_url: target-jsonl

Code

n/a

[tayloramurphy]

The success criteria is near-zero unexpected reformats, aka minimal git diff ‘noise’.

@aaronsteers Agreed on that!

I might lean toward just parameterizing one or two parts of this - perhaps we could just have ‘yaml.array_indent’ being 0/2 or more simply true/false

I like that as well. Let’s consider that a reasonable approach that we’ll accept PRs on but not prioritize ourselves cc @menzenski

[menzenski]

Thanks all - I’m new to Meltano but happy to work on a PR for this. Is there any existing convention around project configuration (as opposed to plugin configuration) I should be aware of?