Deprecating or removing a Plugin

Some plugins may be replaced by others or just become irrelevant. Becoming irrelevant can include an integration with a service that was shut down or a new plugin combining multiple plugins into one. We do not recommend deleting source code outright, even a stale or no-longer-relevant code can still be educational. However, we do have a mechanism for deprecating or hiding plugins in the Jenkins update centers. This page describes the processes for marking a plugin as deprecated or suspending its distribution entirely.

Deprecating a plugin

  1. Set a deprecated label for the plugin that will be visible on and in the Jenkins plugin manager. This can be done in two ways:

    • Put a deprecated topic in the plugin’s GitHub repository. If you have multiple plugins inside a single repository, it will apply to all of them. This is the preferred approach.

    • Add a deprecated label to the plugin entry in the Update Center’s file. Choose this approach if the GitHub repository contains multiple plugins and only some of the plugins in the repository are to be deprecated.

  2. Update the plugin’s documentation to explain the reason of the deprecation.

Archiving the repository

Optionally, you can archive the GitHub repository of the plugin if it has reached the end of its lifecycle or has been superseded by another plugin.

  1. Leave a note in the repository’s README file explaining the reason for archiving and providing a link to the replacement plugin if available.

  2. Close all open issues and pull requests.

  3. Archive the repository.

Removing a plugin from Update Centers

  1. Submit a pull request to the Update Center’s file. Use the artifact ID as key. As value, provide a URL to a web page (usually documentation) that explains to users why distribution is suspended. Specifying a URL will also cause a deprecation message to appear.

  2. Archive the plugin’s GitHub repository.

    • If you have admin permissions in the repository, it is possible to do it from the GitHub’s web interface.

    • Otherwise, create a help desk ticket to archive the plugin’s repository.

Reverting deprecation/removal

If required, it is possible to revert all the actions above. A helpdesk ticket is required to unarchive a plugin, but the rest can be done via pull requests to the respective update center files mentioned above.