Breaking changes in minor version upgrade 0.9.1 -> 0.9.2

[b4u-mw]

The upgrade 0.9.1 from 0.9.2 is a breaking change. The changelog states this:

After upgrade to this release, projects with previous migration files generated by 'aerich<=0.9.1', must run the following command to fill 'MODELS_STATE' into the migration files.

Nevertheless, this is a minor version update. A breaking change should update the major version.

See UpstreamDataInc/goosebit#393 how such things breaks software that uses this library.

[waketzheng]

Run the following script to fix-migrations without aerich table:

import anyio
from aerich import TortoiseContext
from aerich.migrate import Migrate
from aerich.utils import (
    CONFIG_DEFAULT_VALUES,
    _load_tortoise_aerich_config,
    add_src_path,
    get_formatted_compressed_data,
    get_models_describe,
)

TEMPLATE = """

MODELS_STATE = (
    {models_state}
)
"""


async def main() -> None:
    app = "models"
    tortoise_config, aerich_section = _load_tortoise_aerich_config()
    async with TortoiseContext(tortoise_config):
        model_describe = get_models_describe(app=app)
        models_state = get_formatted_compressed_data(model_describe)
        text = TEMPLATE.format(models_state=models_state)
        src_folder = aerich_section.get(
            "src_folder", CONFIG_DEFAULT_VALUES["src_folder"]
        )
        add_src_path(src_folder)
        location = aerich_section.get("location", "./migrations")
        Migrate.migrate_location = Migrate.get_migration_dir(location, app)
        last_migration_file = Migrate.get_last_version_file()
        if last_migration_file is None:
            raise FileNotFoundError(f"No migration file in {location}")
        if not last_migration_file.endswith(suffix := ".py"):
            last_migration_file += suffix
        last_migration = Migrate.migrate_location / last_migration_file
        if text in last_migration.read_text(encoding="utf-8"):
            print(f"{last_migration_file} already has MODELS_STATE section, skip.")
        else:
            with last_migration.open("a+", encoding="utf-8") as f:
                f.write(text)
            print(f"{last_migration_file} updated!")


if __name__ == "__main__":
    anyio.run(main)

[b4u-mw]

@waketzheng Thank you a lot for explaining how to fix it.

But my point was that the version number change was a minor one (0.9.1 -> 0.9.2) but it contains breaking changes. IMO it would be better to increase the version in such cases (0.9.1 -> 1.0.0 or 0.10.0 at least)

[da-i]

Thank you for Aerich! its great waketzheng.
But i agree that this should have been 0.10 at least. i understand that its pre 1.0 software, and that this is not a reason to go into 1.0. But breaking changes should not be considered minor bumps. A good resource for this stuff is:
https://semver.org/

Keep up the good work!