Ore icon indicating copy to clipboard operation
Ore copied to clipboard

UX: Plugin Authors must be notified about using un-recommended dependencies.

Open ryantheleach opened this issue 6 years ago • 0 comments

Plugin Authors uploading Sponge Plugins that are built against snapshot API versions MUST be warned and MUST accept to continue their upload via the website.

People will argue this is useless, but people skim read the docs, they only read what they care about, this is our last chance to educate users before they publish a plugin.

Sample copy text that I would use:

""" Your plugin relies on a SNAPSHOT API release (7.1.0-SNAPSHOT) This will severely limit your compatibility with users and potential audience. Your plugin may break compatibility before API 7.1.0 is released.

To fix this, change your dependency to 7.0.0, or delay publishing until 7.1.0

e.g.

Maven

Insert maven instructions for specifying a dependency.

Gradle

Insert gradle instructions for specifying a dependency.

Manually

Insert instructions for manually changing your MCMOD.info

Do you want to continue your upload? Yes/NO """

Edit: @progwml6 Raised the issue of how to deal with this for gradle ore integration.

I'd ignore it. People using the Gradle Ore plugin could be assumed to know what they are doing if it complicates upload too much. This is more a last effort ditch at education rather then a hard requirement for upload, so I feel being slightly forgiving here is better then having to flat out deny.

It could be built into the client side Ore integration of building as some form of warning when building as we can catch it sooner, but I wouldn't mandate it for upload.

ryantheleach avatar Jan 29 '18 01:01 ryantheleach