feat(config): migrate inline with the same sort

[pret-a-porter]

Changes:

Refactor migrations to provide ability to migrate and save original order of properties in configuration

Context:

#11459

Documentation

• I have updated the documentation, or
• No documentation update is required

How I've tested my work

I have verified these changes via:

• Code inspection only, or
• Newly added/modified unit tests, or
• No unit tests but ran on a real repository, or
• Both unit tests + ran on a real repository

[rarkins]

Are you planning to rewrite every single migration rule in one go? I would prefer to avoid that if so - too much risk of missing something

[pret-a-porter]

Are you planning to rewrite every single migration rule in one go? I would prefer to avoid that if so - too much risk of missing something

Nope, I guess in one go it will be too huge PR. If you agree with idea, I will move step by step.

[rarkins]

OK please get one step working first to demonstrate. I was hoping you would use the code I posted earlier which solves the majority of the problem in one go

[HonkingGoose]

From our Pull Request template:

Please do not force push to your PR's branch after you have created your PR, as doing so forces us to review the whole PR again.

This makes it harder for us to review your work because we don't know what has changed.

PRs will always be squashed by us when we merge your work. Commit as many times as you need in this branch.

[pret-a-porter]

OK please get one step working first to demonstrate. I was hoping you would use the code I posted earlier which solves the majority of the problem in one go

https://github.com/renovatebot/renovate/pull/12091/files#diff-6c6bef2e9a0f4b1863006b6c796698bedb832302c1c56b147e6471ae043684eaR31 this test checks, that MigrationService saves original order of configuration properties

Also I have added examples for different migrations

[pret-a-porter]

@rarkins I have tried to run against https://github.com/pret-a-porter-testing/renovate-reproduction-11459/blob/main/renovate.json

[rarkins]

@rarkins I have tried to run against pret-a-porter-testing/renovate-reproduction-11459@main/renovate.json

When you test, it's best if you can include some non migrated config too, so that we can observe they are ordered correctly even if not migrated.

[pret-a-porter]

@rarkins sorry, I did not get it. I have created repository with non migrated config https://github.com/pret-a-porter-testing/renovate-reproduction-11459. On screenshot you can see lines with oldConfig and newConfig. Shall I do something else?

[rarkins]

@rarkins sorry, I did not get it. I have created repository with non migrated config pret-a-porter-testing/renovate-reproduction-11459. On screenshot you can see lines with oldConfig and newConfig. Shall I do something else?

Yes, you need to do something else. Every config option in newConfig has been migrated. You should test with a mix of migrated and non-migrated (does not need migration) config.

[pret-a-porter]

@rarkins done

Also you can provide some more specific config for testing

[rarkins]

Can you put ignoreTests last and verify that it remains last?

[rarkins]

Actually, have a mix of non-migrated fields first, last and in the middle of migrated and verify ordering remains as expected

[pret-a-porter]

@rarkins done as well

[pret-a-porter]

@rarkins shall I do any other validations regarding this PR?

[rarkins]

@rarkins done as well

This test doesn't interleave migrated and non-migrated. It has all migrated first, then non-migrated. Can you e.g. move versionScheme last in the old config?

[pret-a-porter]

@rarkins it works fine

[renovate-release]

🎉 This PR is included in version 29.12.0 🎉

The release is available on:

• GitHub release
• 29.12.0

Your semantic-release bot 📦🚀