/sami-phpci-plugin

PHPCI plugin for Sami integration

Primary LanguagePHPMIT LicenseMIT

Sami PHPCI Plugin

Sami PHPCI Plugin gives the possibility to generate a documentation with Sami in PHPCI.

⚠️ This project is no longer maintained. ⚠️

Installation

This plugin can be installed via composer:

composer require mauchede/sami-phpci-plugin

Usage

This plugin takes the following options:

  • config (string, optional): Allows you to pass the Sami configuration file. The default value is ./sami.php.
  • force (boolean, optional): Allows you to force (or not) to rebuild from scratch. The default value is true.

An example of phpci.yml with this plugin:

complete:
    \Mauchede\PHPCI\Plugin\Sami:
        config: sami.config.file
        force: false

Links