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

Plugin uses the reserved maven prefix "maven." #717

Closed
andrzejj0 opened this issue Sep 21, 2022 · 4 comments
Closed

Plugin uses the reserved maven prefix "maven." #717

andrzejj0 opened this issue Sep 21, 2022 · 4 comments

Comments

@andrzejj0
Copy link
Contributor

As noted in #454, versions-maven-plugin should not be using the maven property prefix. Hereby changing this to mojohaus.versions, as agreed there.

This is a breaking change.

andrzejj0 added a commit to andrzejj0/versions-maven-plugin that referenced this issue Sep 21, 2022
andrzejj0 added a commit to andrzejj0/versions-maven-plugin that referenced this issue Sep 21, 2022
@andrzejj0 andrzejj0 changed the title Plugin uses proprietary maven prefix Plugin uses the proprietary maven prefix "maven." Sep 22, 2022
andrzejj0 added a commit to andrzejj0/versions-maven-plugin that referenced this issue Sep 27, 2022
@andrzejj0 andrzejj0 changed the title Plugin uses the proprietary maven prefix "maven." Plugin uses the reserved maven prefix "maven." Sep 28, 2022
@slawekjaranowski
Copy link
Member

For me versions. as prefix will be ok.

As such changes are not compatible, I would see one property per one PR with title like Rename property xxx to yyy

I would to show those change in clear way in release notes.

@andrzejj0
Copy link
Contributor Author

I would to show those change in clear way in release notes.

Should I update something?

@slawekjaranowski
Copy link
Member

I would like to review it and discus more ....

I agree that properties begins from maven. should be not used.

What I see:

  • in project most of properties are not prefixed
  • if prefix is used it is versions - not version ( at most case )

To think about:

  • whether to use a prefix at all
  • if property is dedicated for cli maybe without prefix is better ... i'm layzy
  • whether all Mojo Parameters need property?

@andrzejj0
Copy link
Contributor Author

andrzejj0 commented Oct 20, 2022

My thoughts

  • prefixes make sense if the plugin is used in combination with other plugins
  • currently this is difficult to imagine, but let's say we introduce a feature that would work in combination with the enforcer plugin, i.e. conditions for failure
  • I don't think all pom.xml properties need a user property, but it makes it much easier to test the plugin using options passed via invoker.properties
  • long property names make the possibility of collisions (with other plugins) less likely, but they can of course still occur
  • if property is dedicated for cli maybe without prefix is better ... i'm layzy -> let's just use 'versions' for short/collision prone property names

@andrzejj0 andrzejj0 reopened this Nov 24, 2022
@andrzejj0 andrzejj0 closed this as not planned Won't fix, can't repro, duplicate, stale Nov 24, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants