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

Remove Duplicate settings #328

Open
Michaelpalacce opened this issue Jul 15, 2024 · 5 comments
Open

Remove Duplicate settings #328

Michaelpalacce opened this issue Jul 15, 2024 · 5 comments
Assignees
Labels
area/artifact-manager Relates to the `artifact-manager` maven module area/installer Relates to the solution installer area/mojo Relates to changes to some of the mvn mojos effort/medium kind/enhancement Enhancement or improvement of existing features lang/java Related to Java Code triage/accepted The issue was accepted and will be done version/major Introduces a breaking change
Milestone

Comments

@Michaelpalacce
Copy link
Collaborator

Michaelpalacce commented Jul 15, 2024

Description

There are similar in meaning settings in the settings.xml:

  • project.id and project.name
  • org.id and org.name

Similar properties are also present in the installer.

The ability to pass id should be entirely removed from BTVA and instead we should be using the name options as that will fetch the correct org or project. ids generally cause issues in Aria and BTVA when changing environments.

Example

Use case for this would be:

You are developing a Windows template, you have a Project setup for that template, called Windows and you want to preserve that in another environment, if you use ids you will need to specify 1 id for each environment, however using name has no such problem.

Notes

  • Documentation needs to be updated accordingly
  • We need to decide if we want project.id to still be usable and only add a deprecation warning or completely remove it.
@Michaelpalacce Michaelpalacce added kind/enhancement Enhancement or improvement of existing features lang/java Related to Java Code area/artifact-manager Relates to the `artifact-manager` maven module area/installer Relates to the solution installer version/major Introduces a breaking change triage/needed Needs to be discussed by project maintainers area/mojo Relates to changes to some of the mvn mojos effort/medium labels Jul 15, 2024
@VenelinBakalov
Copy link
Collaborator

One more thing to clarify is if we completely remove, should we consider this as potential major change.

@VenelinBakalov
Copy link
Collaborator

@Michaelpalacce we had a short discussion regarding this topic, basically we should do it only if there is some hard benefit to it.
Should we do it, we need to consider:

  1. Adding a deprecation warning during the push execution for 2.x and introduce the breaking change in 3.x
  2. Do the same in the installer

@Michaelpalacce Michaelpalacce added this to the 3.0.0 milestone Sep 3, 2024
@VenelinBakalov VenelinBakalov added triage/accepted The issue was accepted and will be done and removed triage/needed Needs to be discussed by project maintainers labels Sep 10, 2024
@VenelinBakalov
Copy link
Collaborator

Whoever takes this, please note that this is a 2 step fix - 1 action item for the current major version and 1 future removal for 3.x milestone

@VenelinBakalov
Copy link
Collaborator

Agreed to execute this (as discussed above, in 2-step approach) as having both properties:

  1. Leads to confusion in Built Tools consumers
  2. Makes code handling more complex in any form of module extensions that use project or org identifiers
  3. Leads to confusion when onboarding developers

@Michaelpalacce
Copy link
Collaborator Author

@VenelinBakalov Since we are working on 3.x.x, should we just remove it then? Or add a deprecation warning and do it for a later on release?

@Michaelpalacce Michaelpalacce self-assigned this Oct 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/artifact-manager Relates to the `artifact-manager` maven module area/installer Relates to the solution installer area/mojo Relates to changes to some of the mvn mojos effort/medium kind/enhancement Enhancement or improvement of existing features lang/java Related to Java Code triage/accepted The issue was accepted and will be done version/major Introduces a breaking change
Projects
None yet
Development

No branches or pull requests

2 participants