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.

Global plugins




Page generated by Alambic 3.3.2 on Wed Oct 18 18:05:08 2017.