Documentation Plugins



Plugins add new functionalities to Alambic. They most notably provide new data sources for projects, computing and visualisation features, and can be easily customised to fit specific needs. Each plugin provides a set of abilities, which are features they provide to the system:

  • Information: meta-data, pieces of information relevant to the project. Examples are the project's description and name, the URL of repositories, etc.
  • Metrics: meta-data, pieces of information relevant to the project. Examples are the project's description and name, the URL of repositories, etc.
  • Figures: meta-data, pieces of information relevant to the project. Examples are the project's description and name, the URL of repositories, etc.
  • Downloads: meta-data, pieces of information relevant to the project. Examples are the project's description and name, the URL of repositories, etc.
  • Recommendations: meta-data, pieces of information relevant to the project. Examples are the project's description and name, the URL of repositories, etc.
  • Visualisations: meta-data, pieces of information relevant to the project. Examples are the project's description and name, the URL of repositories, etc.

Plugins are organised into types, which define when they are executed and the information they have access to.

  • Pre- plugins, also known as data source plugins, are executed first. They usually retrieve information from a repository, and compute metrics and recommendations.
  • When all pre- plugins are executed, Alambic computes the attributes and quality model and executes the post- plugins. These have access to all information, custom data, metrics, attributes and recommendations retrieved and computed by pre plugins, and are a good fit for project-level reports.
  • When all projects have been executed, the global plugins are run. They have access to all information from all projects and are a good fit for installation-wide reports.

Two other types of plugins independent of project analysis are further defined:

  • Custom data plugins provide information entered by users, like comments or surveys. As such the data they provide is not synchronised with project runs, altough they still provide the same type of output (metrics, downloads, figures, etc.).
  • Wizards provide an easy way to setup a project with a predefined set of plugins. Wizards can execute code to initialise the plugins with the correct parameters and check consistency of entries.

Wizards


Eclipse PMI Wizard

ID: EclipsePmi

Parameters:

Description:
The Eclipse PMI wizard creates a new project with all data source plugins needed to analyse a project from the Eclipse forge, including Eclipse ITS, Eclipse MLS, Eclipse PMI, Eclipse SCM and Hudson CI. It retrieves and uses values from the PMI repository to set the plugin parameters automatically.
This wizard only creates the plugins that should always be available. Depending on the project's configuration and data sources availability, other plugins may be needed and can manually be added to the configuration.



Page generated by Alambic 3.3 on Wed Apr 26 09:51:10 2017.