Child pages
  • Plugin Site Information for Plugin Developers

Due to some maintenance issues, this service has been switched in read-only mode, you can find more information about the why

and how to migrate your plugin documentation in this blogpost

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

This page explains how the plugins site works. The intended audience is plugin developers.

This is not a manual on how to use the site to e.g. find plugins, but rather explains how it gets its data and how plugin developers can change the data on it.

Data shown on the plugins site

'Most installed' plugins, and plugin installation trend

This uses the monthly data from http://stats.jenkins.io/ as gathered from Jenkins instances that have not opted out of reporting data.

Learn more: https://wiki.jenkins-ci.org/display/JENKINS/Usage+Statistics

'Recently updated'

This is based on metadata created by the update site generator, which uses the creation date of a plugin release.

'Trending'

This is an attempt to capture the plugins whose popularity is growing rapidly. As we only have the monthly installation stats for this, it's necessarily a worse approximation than what you'd see e.g. in app stores.

Currently (2016-11) this just divides the most recent month's install count by the previous month's.

Plugin categories

Categories are based on the labels on plugin wiki pages. Those with the plugin- prefix are passed through update site generation, and sent to Jenkins (where they serve to group plugins in the Plugin Manager as well).

The categories are filtered, grouped, and given nicer names based on plugin site configuration here: https://github.com/jenkins-infra/plugin-site-api/blob/master/src/main/resources/categories.json

Some categories that we expect wouldn't mean a lot to users who aren't plugin developers themselves have been filtered out ("plugin wrappers"?).

Plugin "information" (the wiki page)

The plugins site scrapes the plugin's wiki page, transforms it a bit (e.g. makes table of content links not link to wiki.jenkins-ci.org, but to the plugin site), and caches it. Currently, plugin wiki pages are cached for 12 hours.

Changes to plugin wiki pages will therefore take effect with some delay on the plugin site.

Maintainers

These are taken from the plugin's latest released version's metadata, and additionally includes the user who released that version.

Dependencies and display name

These are all taken from the plugin's latest released version's pom.xml metadata.

Implicit dependencies (plugins split from core) are currently not included.

Data collection and caching

Wiki page data

The plugin site caches wiki pages as needed. The cached copy of each wiki page is marked invalid after several (2016-11: six) hours.

Statistics and other plugin metadata

The data for the plugins site is periodically collected based on the stats.jenkins.io data and the current update-center.json, and made available to the plugins site at a known URL.

The plugins site periodically (2016-11: every 12 hours) updates its internal storage from that URL.

  • No labels