recipe-runner / module-template
A module for Recipe Runner
dev-master / 1.0.x-dev
2019-09-11 09:40 UTC
Requires
- php: ^7.2
- recipe-runner/recipe-runner: 1.0.x-dev
Requires (Dev)
- phpunit/phpunit: ^7
This package is auto-updated.
Last update: 2024-10-11 20:32:06 UTC
README
Description of the module goes here.
Please, review all the files before first commit.
Requires
- PHP +7.2
- Recipe Runner
Installation
Create a recipe and add the module to the packages
section:
name: "Your recipe name" extra: rr: packages: "vendor-name/module-name": "1.0.x-dev"
Methods
method_name
Description of the method goes here.
Types allowed: number
, string
, array
, null
Parameters
- parameter1 (
type
) Description of the parameter1. - parameter2 (
type
) Description of the parameter2.
Return values
- name1 (
type
) Description of the name1
Examples
steps: - actions: - method_name: "bla bla"
For module developers
The preferred installation method is Composer:
$ composer require vendor-name/module-name
Unit tests
You can run the unit tests with the following command:
$ cd module-dir $ composer test
License
This library is open-sourced software licensed under the MIT license.