From eaea9c13ac5d650f5202d35454b4ed5c80c1378c Mon Sep 17 00:00:00 2001 From: Daniel Beck Date: Thu, 8 Feb 2018 19:55:42 +0100 Subject: [PATCH 1/2] Better explain extra features --- README.md | 50 +++++++++++++++++++++++++++++++++++++++++++------- 1 file changed, 43 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index e242f1476..703b33875 100644 --- a/README.md +++ b/README.md @@ -22,17 +22,53 @@ The generator can: * download the hpis and wars * sign the json files -Extra features: - -* allow to blacklist plugins to ignore. See src/main/resources/artifact-ignores.properties -* temporary override of the plugins wiki page. src/main/resources/wiki-overrides.properties -* definition of labels, or categories, for plugins. See src/main/resources/label-definitions.properties - The generator pulls information from: * a nexus index site * remote and local maven repositories -* confluence + +Extra features +-------------- + +* Removing plugins from distribution +* temporary override of the plugins wiki page. src/main/resources/wiki-overrides.properties +* Categorizing plugins +* Security warnings + + +### Categorizing plugins + +Jenkins groups plugins into various categories in the plugin manager. + +These categories historically were labels on the plugins' wiki page with Jenkins applying localization on the raw label value, if defined. +To remove the need to scrape wiki pages in this tool, we've changed this behavior, and plugins now have the labels defined in this repository. +See the file `src/main/resources/label-definitions.properties` for the plugin/label assignments. + +See https://github.com/jenkinsci/jenkins/blob/master/core/src/main/resources/hudson/model/Messages.properties (look for `UpdateCenter.PluginCategory`) for the localization overrides Jenkins applies. + + +### Removing plugins from distribution + +The update center generator allows to specify that certain plugins, or plugin releases, should not be included in the output. + +There are various reasons to need to do this, such as: + +* A plugin release causes major regressions and a fix is not immediately available. +* A plugin integrates with a service that has been shut down. + +Both use cases (entire plugins, or specific versions) are controlled via the file `src/main/resources/artifact-ignores.properties`. +See that file for usage examples. + + +### Security warnings + +Since the releases 2.32.2 and 2.40, Jenkins can display security warnings about core and plugins. +These warnings are part of the update center metadata downloaded by Jenkins. +These warnings are defined in the file `src/main/resources/warnings.json`. + + +Usage +----- The generator doesn't have a full usage page yet. Meanwhile you can read the code of [the arg4js annotated Main class](https://github.com/jenkinsci/backend-update-center2/blob/master/src/main/java/org/jvnet/hudson/update_center/Main.java) From 8f6c9e53924223ee1533d7f0ad479e0c1c2438a2 Mon Sep 17 00:00:00 2001 From: Daniel Beck Date: Fri, 9 Feb 2018 11:41:14 +0100 Subject: [PATCH 2/2] Describe wiki page overrides --- README.md | 18 ++++++++++++------ 1 file changed, 12 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 703b33875..42f772318 100644 --- a/README.md +++ b/README.md @@ -30,12 +30,6 @@ The generator pulls information from: Extra features -------------- -* Removing plugins from distribution -* temporary override of the plugins wiki page. src/main/resources/wiki-overrides.properties -* Categorizing plugins -* Security warnings - - ### Categorizing plugins Jenkins groups plugins into various categories in the plugin manager. @@ -47,6 +41,18 @@ See the file `src/main/resources/label-definitions.properties` for the plugin/la See https://github.com/jenkinsci/jenkins/blob/master/core/src/main/resources/hudson/model/Messages.properties (look for `UpdateCenter.PluginCategory`) for the localization overrides Jenkins applies. +### Wiki Page Override + +Plugins are generally expected to provide a `` to their documentation in their POM. +Historically, these URLs have been pages on the Jenkins wiki, but can point anywhere. +The wiki page override feature was primarily used when wiki pages were a requirement for plugins to be distributed by this tool at all. + +This requirement no longer exists, but it may still be useful to define a documentation URL for plugins that don't do that: +Due to update center tiers that can result in older releases of a plugin being distributed, it might not be enough to have a URL in the latest release. + +The file `src/main/resources/wiki-overrides.properties` defines these wiki page overrides. + + ### Removing plugins from distribution The update center generator allows to specify that certain plugins, or plugin releases, should not be included in the output.