1. Sebastian Sebastian
  2. scm-manager

Wiki

Clone wiki

scm-manager / plugin-descriptor

Plugin Descriptor

The plugin descriptor contains informations and instructions for the scm-manager to integrate the plugin. The descriptor is located at META-INF/scm/plugin.xml in the package of a plugin.

ElementDescriptionMultiple
pluginRoot element of the plugin descriptor
plugin/conditionPlugin condifitions
plugin/condition/archProcessor architecture (x86/amd64)
plugin/condition/min-versionMinimum version of SCM-Manager
plugin/condition/osOperation System
plugin/condition/os/nameName of the Operating SystemX
plugin/informationContains informations of the plugin for the plugin backend
plugin/information/artifactIdMaven artifact id
plugin/information/authorThe Author of the plugin
plugin/information/categoryCategory of the plugin
plugin/information/descriptionDescription of the plugin
plugin/information/groupIdMaven group id
plugin/information/nameName of the plugin
plugin/information/screenshotsContains screenshots of the plugin
plugin/information/screenshots/screenshotSingle screenshot of the pluginX
plugin/information/urlThe url of the plugin homepage
plugin/information/versionThe current version of the plugin
plugin/information/wikiThe url of a wiki page
plugin/packagesJava packages which are being searched for extensions
plugin/packages/packageSingle Java packages which is being searched for extensionsX
plugin/resourcesContains resources for the web interface (stylesheets and JavaScript files)
plugin/resources/scriptJavaScript file for the web interfaceX
plugin/resources/stylesheetStylesheet for the web interfaceX

Example of the plugin descriptor:

<?xml version="1.0" encoding="UTF-8"?>
<plugin>

  <!-- 
    Informations for the plugin backend.
    The elements groupId, artifactId, name, version and url
    are automatically added from the pom.xml by a maven plugin (since 1.5).
  -->
  <information>
    <author>Sebastian Sdorra</author>
  </information>

  <!-- 
    pluigin requires SCM-Manager version 1.7 
  -->
  <conditions>
    <min-version>1.7</min-version>
  </conditions>
  
  <!-- 
    register package for plugin extension finder 
   -->
  <packages>
    <package>sonia.scm.jenkins</package>
  </packages>

  <!-- 
    register javascript file 
   -->
  <resources>
    <script>/sonia/scm/sonia.jenkins.js</script>
  </resources>

</plugin>

Updated