versions icon indicating copy to clipboard operation
versions copied to clipboard

Plugin uses the reserved maven prefix "maven."

Open andrzejj0 opened this issue 3 years ago • 2 comments

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 avatar Sep 21 '22 17:09 andrzejj0

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.

slawekjaranowski avatar Sep 29 '22 06:09 slawekjaranowski

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

Should I update something?

andrzejj0 avatar Oct 04 '22 04:10 andrzejj0

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?

slawekjaranowski avatar Oct 20 '22 18:10 slawekjaranowski

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 avatar Oct 20 '22 19:10 andrzejj0