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

Create UpgradeSettingsCommandlet #759

Open
12 tasks
hohwille opened this issue Nov 13, 2024 · 0 comments
Open
12 tasks

Create UpgradeSettingsCommandlet #759

hohwille opened this issue Nov 13, 2024 · 0 comments
Assignees
Labels
configuration should be configurable or configuration change enhancement New feature or request settings ide-settings repo and replated processes and features

Comments

@hohwille
Copy link
Member

hohwille commented Nov 13, 2024

As a IDEasy user comming from a devonfw-ide project, I want to have a command to upgrade my settings from devonfw-ide to IDEasy so that I can get rid of all legacy after all my team members have already switched to IDEasy.

An UpgradeSettingsCommandlet shall be added so I can run ide upgrade-settings to upgrade my settings:

  • all devon.properties are renamed to ide.properties. In case a corresponding ide.properties already exists, the config from the devon.properties is merged into the existing ide.properties. This not only applies to settings but also to conf and all workspaces.
  • We ensure all legacy variables in ide.properties are replaced with their new name (if both legacy and new variable name is defined, the legacy one is removed).
  • Duplicated variables in the same ide.properties are removed (only the last occurrence is kept).
  • If variable DEVON_IDE_CUSTOM_TOOLS exists, it is converted into a custom-tools.json file in settings and the variable is removed (see here and legacy).
  • if settings/devon folder exists, it is renamed to settings/templates
  • XXX if settings/templates/conf/.m2 folder exists, it is renamed to settings/templates/conf/mvn
  • if settings/projects folder exists, it is renamed to settings/repositories
  • we recursively traverse all files in settings/workspace and settings/*/workspace and replace all known IdeVariables from CURLY into ANGLED syntax and legacy variable names are replaced with their new names. So e.g. ${DEVON_IDE_HOME} is replaced with $[IDE_HOME] or ${MAVEN_VERSION} is replaced with $[MVN_VERSION]. We also need to replace ${SETTINGS_PATH} with $[IDE_HOME]/settings.
  • if we hit an xml file that is not containing the XML namespace of our merger, we print a warning with the filepath saying that this file is most-likely outdated and print a link to a documentation page about this settings migration feature and linking to our XML merger docs in configurator and telling the project to sync their workspace config manually with the official ide-settings git repo on github provided by us as template for the settings.
  • that documentation page needs to exist and open when I click the link from that warning and explain the migration from devonfw-ide to IDEasy.
  • if a replacement-patterns.properties is found in a workspace folder a warning will be logged if the file is not empty and the file will be deleted.
  • if settings/ide.properties does not contain IDE_VARIABLE_SYNTAX_LEGACY_SUPPORT_ENABLED=false it will be added.

General note:

  • points above marked with XXX are potentially dangerous and we should discuss if we want to ask the user before applying the change. Therefore the user must understand the impact, what might not be so easy to explain. For .m2 vs. mvn all existing installations also need to be updated. IMHO I cared about compatibilities and fallbacks in our code so it should not break but maybe some templates may contain hardcoded references to .m2 and will stop working then.
  • Whenever it says a folder shall be renamed, it must be ensured that the new name does not already exist. Otherwise the rename should not take place and a warning must be logged.
@hohwille hohwille added the enhancement New feature or request label Nov 13, 2024
@github-project-automation github-project-automation bot moved this to 🆕 New in IDEasy board Nov 13, 2024
@hohwille hohwille added settings ide-settings repo and replated processes and features configuration should be configurable or configuration change labels Nov 13, 2024
@KianRolf KianRolf self-assigned this Nov 19, 2024
@KianRolf KianRolf moved this from 🆕 New to 🏗 In progress in IDEasy board Nov 19, 2024
@leonrohne27 leonrohne27 self-assigned this Nov 19, 2024
leonrohne27 added a commit to leonrohne27/IDEasy that referenced this issue Nov 19, 2024
KianRolf added a commit to leonrohne27/IDEasy that referenced this issue Nov 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
configuration should be configurable or configuration change enhancement New feature or request settings ide-settings repo and replated processes and features
Projects
Status: 🏗 In progress
Development

No branches or pull requests

3 participants