Missing documentation for tagging plugins inside plugin manager

[DuMaM]

Describe your use-case which is not covered by existing documentation.

Hi,

As plugin maintainer I would like to stay on healthy and good relations with my community. 😉 I find informing them about crucial or breaking changes can be handy for everybody. I've looked around for anything related to marking plugins with banners like breaking changes or others in plugin manager, but sadly i didn't find anything useful for me. There's documentation about plugin deprecation and abandonment, but sadly that's all 😢

Could we improve this somehow to make plugin developers life easier 🙏 Thanks

Reference any relevant documentation, other materials or issues/pull requests that can be used for inspiration.

Reference: https://www.jenkins.io/doc/developer/plugin-governance/deprecating-or-removing-plugin/#ji-toolbar

[zbynek]

I think this is what you want: https://www.jenkins.io/doc/developer/plugin-development/mark-a-plugin-incompatible/

[DuMaM]

Thanks, that'll do the trick. Could we add keywords like breaking changes to this page? 😉 I think more people will look for this expression than for incompatible I also think it will fit better in this subdir. https://www.jenkins.io/doc/developer/publishing/

[zbynek]

@DuMaM feel free to create a PR changing the text, you can just edit the relevant file in GitHub https://github.com/jenkins-infra/jenkins.io/edit/master/content//doc/developer/plugin-development/mark-a-plugin-incompatible.adoc , thanks

For moving content between sections maybe let's wait until the new navigation is finished c.f. https://github.com/jenkins-infra/jenkins.io/pull/5570

[DuMaM]

Sure. @zbynek one last question is there any official way to mark that plugin no longer support java 8?

[zbynek]

@DuMaM bump the minimum Jenkins version to a recent one, that will make sure the new version of your plugin is only available for user running new Jenkins which requires Java 11 (you can pick 2.361.1 or later, see https://www.jenkins.io/changelog-stable/ )

[DuMaM]

Ok, but in such situation does user will be informed about it? My goal here is to have banner like in incompatible docs in plugin manager. I also found something like this, and I wondering if i have to do similar stuff to display such msg. https://github.com/jenkinsci/workflow-multibranch-plugin/blob/c692ae52371b564c718e993db922dd3aeaa1b441/pom.xml#L227

[zbynek]

Ok, but in such situation does user will be informed about it?

If they run a new Jenkins (on Java 11) they can just install the plugin. If they run an old Jenkins (either Java 8 or 11) they get a message saying something like "newer version of plugin is available, but only for new Jenkins releases".

I also found something like this

That is no longer supported https://github.com/jenkinsci/jenkins/pull/6549

[DuMaM]

thanks :)