openstack/mistral
Code Issues Proposed changes

Update the Custom Action documentation to use mistral-lib

Browse Source 
We should have updated this some time ago. Importing mistral itself
hasn't been the best way to write actions for a while.

Change-Id: I27df8865f8fef81fcfd1cb3de1a2bde6c6281cf6
This commit is contained in:
Dougal Matthews 2018-07-23 14:14:40 +01:00
parent 38bfd91a22
commit e1e6c7a0cf
1 changed files with 5 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
doc/source/contributor/creating_custom_action.rst
View File

@ -6,9 +6,9 @@ How to write a Custom Action
.. code-block:: python
from mistral.actions import base
from mistral_lib import actions
class RunnerAction(base.Action):
class RunnerAction(actions.Action):
def __init__(self, param):
# store the incoming params
self.param = param
@ -27,15 +27,10 @@ How to write a Custom Action
mistral.actions =
example.runner = my.mistral_plugins.somefile:RunnerAction
3. Reinstall Mistral if it was installed in system (not in virtualenv).
3. Install the Python package containing the action. If this was added to
Mistral itself it will need to be reinstalled.
4. Run db-sync tool via either
.. code-block:: console
$ tools/sync_db.sh --config-file <path-to-config>
or
4. Run the following command so Mistral discovers the new action
.. code-block:: console