✨ [#139] Integrate django-upgrade-check

[OlhaZahoruiko]

Fixes maykinmedia/open-api-framework#139

Changes

[Describe the changes here]

[codecov-commenter]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 94.66%. Comparing base (37796bb) to head (4edbe8d).

Additional details and impacted files

@@           Coverage Diff           @@
##           master     #617   +/-   ##
=======================================
  Coverage   94.66%   94.66%           
=======================================
  Files         148      148           
  Lines        5171     5171           
=======================================
  Hits         4895     4895           
  Misses        276      276           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

[Floris272]

In conf/base.py upgrade_check needs to added to INSTALLED_APPS
and the following needs to be added:

UPGRADE_CHECK_PATHS: UpgradePaths = {
    "<NEXT_VERSION_HERE>": UpgradeCheck(VersionRange(minimum="<CURRENT_VERSION_HERE>")),
}

Sergei also mentioned to add the upgrade simulation: https://github.com/maykinmedia/open-klant/pull/404/files (versions need to be changed)


UPGRADE_CHECK_STRICT = False

Sergei also mentioned to add the upgrade_simulation job https://github.com/maykinmedia/open-klant/pull/404/files

[OlhaZahoruiko]

In conf/base.py upgrade_check needs to added to INSTALLED_APPS and the following needs to be added:

UPGRADE_CHECK_PATHS: UpgradePaths = {
    "<NEXT_VERSION_HERE>": UpgradeCheck(VersionRange(minimum="<CURRENT_VERSION_HERE>")),
}

Sergei also mentioned to add the upgrade simulation: https://github.com/maykinmedia/open-klant/pull/404/files (versions need to be changed)


UPGRADE_CHECK_STRICT = False

Sergei also mentioned to add the upgrade_simulation job https://github.com/maykinmedia/open-klant/pull/404/files

@danielmursa-dev, you mentioned yesterday that I should remove it from INSTALLED_APPS and PATHS.
@Floris272 and @danielmursa-dev would it be possible for you to agree on one approach?

[danielmursa-dev]

@Floris272 the library is already installed in open-api-framework, so all projects can simply extend the INSTALLED_APPS from oaf.
Instead for the settings.py, I think now it is not necessary because at the moment, except open-klant, there is no mandatory versions that the projects are forced to update before the new ones.
So now the library installation is sufficient, to keep track of versions and in the future if it is needed it will be added in the settings

[danielmursa-dev]

Why was this line deleted?

[OlhaZahoruiko]

It was removed to fix a ruff formatting error: "Import block is un-sorted or un-formatted."

[danielmursa-dev]

Mmmm weird because the Path is used within the file, for example here:

objects-api/src/objects/conf/base.py

Line 248 in c63ea03

"filename": Path(LOGGING_DIR) / "celery.log",

[OlhaZahoruiko]

I added it back

[danielmursa-dev]

OAF 0.10.2 has just been released, so you can run ./bin/compile_dependencies.sh to update the requirements, the same thing for the other projects as well, then everything is fine