Guidance on how to release a new version of a plugin with a breaking change

[Claudiu Guiman]

Hi,
We’re currently working on storing the credentials of Azure storage plugin in the Credentials Manager. When we’ll release, upgrading from an older version to the latest will remove existing credentials and the users will have to manually add them again. I know it’s not good to have breaking changes, but this one will have major security benefits.
Do you have some guidance on how to let the users know about the impact upgrade will have. From your experience, is it enough just to state this in the plugin’s wiki page?

Thank you,
Claudiu Guiman

[Slide]

Hi Claudiu,

Is there a reason you can't provide an upgrade path from the current credentials? Have you looked at https://wiki.jenkins-ci.org/display/JENKINS/Hint+on+retaining+backward+compatibility?

Slide

--
You received this message because you are subscribed to the Google Groups "Jenkins Developers" group.
To unsubscribe from this group and stop receiving emails from it, send an email to jenkinsci-de...@googlegroups.com.
To view this discussion on the web visit https://groups.google.com/d/msgid/jenkinsci-dev/CY1PR0301MB166021B352B70698E861411FD78D0%40CY1PR0301MB1660.namprd03.prod.outlook.com.
For more options, visit https://groups.google.com/d/optout.

[Claudiu Guiman]

Hi,
I wasn’t aware that’s a possibility J . I’ll definitely try that.

Thanks,
Claudiu

To view this discussion on the web visit https://groups.google.com/d/msgid/jenkinsci-dev/CAPiUgVfEh572hAQgNj_qWnyKAkJAji2G5iMHc9MsSHiBd4FPjg%40mail.gmail.com.

[Daniel Beck]

> On 29.11.2016, at 21:57, 'Claudiu Guiman' via Jenkins Developers <jenkin...@googlegroups.com> wrote:
>
> I wasn’t aware that’s a possibility J . I’ll definitely try that.

And if that doesn't work out:

https://wiki.jenkins-ci.org/display/JENKINS/Marking+a+new+plugin+version+as+incompatible+with+older+versions

I'd go for the compatible approach unless really not possible though.

[Jesse Glick]

On Tue, Nov 29, 2016 at 3:04 PM, 'Claudiu Guiman' via Jenkins
Developers <jenkin...@googlegroups.com> wrote:
> We’re currently working on storing the credentials of Azure storage plugin
> in the Credentials Manager. When we’ll release, upgrading from an older
> version to the latest will remove existing credentials and the users will
> have to manually add them again.

Plugins are routinely switched to Credentials with compatibility code
that automatically migrates existing secrets. There are numerous
examples you can find; here is one:

https://github.com/jenkinsci/ssh-slaves-plugin/blob/ae2d6dee1a03a155c991809a4fcac11c5537bdd9/src/main/java/hudson/plugins/sshslaves/SSHLauncher.java#L512-L546

[Gavin Mogan]

I took a bit more of an automatic approach. It updates on startup

https://github.com/jenkinsci/sauce-ondemand-plugin/blob/e67c8573775be8222a5784d85d9fcca980be92d6/src/main/java/hudson/plugins/sauce_ondemand/SauceOnDemandBuildWrapper.java#L1011-L1063