allow ignoring comments in migration checksum

[siosw]

I have found these related issues/pull requests

/

Description

currently migration checksums include comments, this makes it hard to change them once a migration has been applied. sometimes this is nice to add more context later etc.

Prefered solution

add some logic filtering out comments here:
https://github.com/launchbadge/sqlx/blob/764ae2f702b15748c56a46a67dc80d719a2977ec/sqlx-core/src/migrate/source.rs#L118

Is this a breaking change? Why or why not?

this would break existing migration checksums so it should be behind a feature flag

[abonander]

This could be implemented on top of #3383

[siosw]

@abonander would love to take a stab at a PR for this. I think we could add a ignore_migration_comments field to the sqlx.toml which defaults to false. if set we ignore comments in the checksum.

wdyt?

[abonander]

@siosw sure! I would style it like this:

[migrate]
ignore-comments = true

You just have to add that field here: https://github.com/launchbadge/sqlx/blob/c825bd36b50b157e68fb1dac542eb4d9fe863850/sqlx-core/src/config/migrate.rs#L21

Also please add it to the reference: https://github.com/launchbadge/sqlx/blob/c825bd36b50b157e68fb1dac542eb4d9fe863850/sqlx-core/src/config/reference.toml#L170

And to the parse test: https://github.com/launchbadge/sqlx/blob/c825bd36b50b157e68fb1dac542eb4d9fe863850/sqlx-core/src/config/tests.rs#L95