Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Upgrade improvements, removed usage of fromVersion parameter #191

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

ShvaykaD
Copy link
Contributor

@ShvaykaD ShvaykaD commented Dec 19, 2024

Pull Request description

Removed old (not supported) upgrades.

For Customers:

  • The --fromVersion parameter is no longer required in upgrade scripts. Upgrades now automatically start from the version currently set in your database.
  • Added validation for DB version. If your database version is not compatible with the current upgrade, you will see the following message in the logs:

image

  • Added validation for redundant upgrades: If you attempt to upgrade a database that is already up-to-date, you will see the following message in the logs:

image

Note: If you need to force an upgrade, you can bypass this validation by setting the SKIP_SCHEMA_VERSION_CHECK environment variable to true.

For Developers:

  • You no longer need to manually set the schema version during installation or upgrades.
  • New tables or indexes should be added directly to schema-entities.sql or schema-entities-idx.sql rather than the upgrade SQL file.
  • Empty upgrade SQL files are no longer required in the upgrade directory. The logic now skips execution for non-existent SQL upgrade files.

General checklist

  • You have reviewed the guidelines document.
  • Labels that classify your pull request have been added.
  • The milestone is specified and corresponds to fix version.
  • Description references specific issue.
  • Description contains human-readable scope of changes.
  • Description contains brief notes about what needs to be added to the documentation.
  • No merge conflicts, commented blocks of code, code formatting issues.
  • Changes are backward compatible or upgrade script is provided.

Front-End feature checklist

  • Screenshots with affected component(s) are added. The best option is to provide 2 screens: before and after changes;
  • If you change the widget or other API, ensure it is backward-compatible or upgrade script is present.

Back-End feature checklist

  • Added corresponding unit and/or integration test(s). Provide written explanation in the PR description if you have failed to add tests.
  • If new dependency was added: the dependency tree is checked for conflicts.

@ShvaykaD ShvaykaD added Enhancement New feature or request Core Minor improvement to Core services and removed Core Minor improvement to Core services labels Dec 19, 2024
@ShvaykaD ShvaykaD added this to the 2.1.0 milestone Dec 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant