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.

Post plugins


Generic R plugin

ID: GenericR

Abilities:   data

Parameters:

Description:
The generic R plugin enables users to easily define their own R markdown files to automatically run analysis on projects.
See the project's wiki for more information.

Provides metrics

Provides figures

Provides data
generic_r.pdf: The PDF document generated from the R markdown file.

Provides recommendations

Provides viz

Project summary

ID: ProjectSummary

Abilities:   figs   viz

Parameters:

Description:
The Project Summary plugin creates a bunch of exportable HTML snippets, images and badges.

Provides metrics

Provides figures
badge_attr_alambic.svg: A badge to display current value of main quality attribute on an external web site (uses shields.io)
badge_attr_root.svg: A badge to display current value of main quality attribute on an external web site (uses shields.io)
badge_downloads: A HTML snippet that displays downloads for main data.
badge_plugins: A HTML snippet that displays a list of plugins for the project.
badge_project_main: A HTML snippet that displays the name and description of the project.
badge_psum_attrs.html: A HTML snippet to display main quality attributes and their values.
badge_qm: A HTML snippet that displays main quality attributes.
badge_qm_viz: A HTML snippet that displays the quality model visualisation.
psum_attrs.html: A HTML snippet to display main quality attributes and their values.

Provides data

Provides recommendations

Provides viz
Badges



Page generated by Alambic 3.3.2 on Mon Dec 18 11:35:55 2017.