From 984fbf84550860d82609d4d5f184e38b4de6fed7 Mon Sep 17 00:00:00 2001 From: blag Date: Tue, 14 Jul 2020 15:52:48 -0700 Subject: [PATCH 1/2] Document st2.action.file_writen trigger rename --- docs/source/upgrade_notes.rst | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/docs/source/upgrade_notes.rst b/docs/source/upgrade_notes.rst index a0e6816bb..f863d861f 100644 --- a/docs/source/upgrade_notes.rst +++ b/docs/source/upgrade_notes.rst @@ -3,6 +3,20 @@ Upgrade Notes ============= +.. _ref-upgrade-notes-v3-3: + +|st2| v3.3 +---------- + +* The ``st2.action.file_writen`` trigger was renamed to ``st2.action.file_written``. As part of the + upgrade to v3.3, please make sure to update all previous references to the + ``st2.action.file_writen`` trigger to ``st2.action.file_written``: + + .. code-block:: yaml + + trigger: + type: "core.st2.action.file_written" + .. _ref-upgrade-notes-v3-2: |st2| v3.2 From a36292a6a3e1ca1fccdbc5b498d2b9957950bbba Mon Sep 17 00:00:00 2001 From: blag Date: Tue, 14 Jul 2020 16:12:32 -0700 Subject: [PATCH 2/2] Fix script to properly generate trigger *references* --- scripts/generate-internal-triggers-table.py | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/scripts/generate-internal-triggers-table.py b/scripts/generate-internal-triggers-table.py index afaaab54e..61eea0fde 100755 --- a/scripts/generate-internal-triggers-table.py +++ b/scripts/generate-internal-triggers-table.py @@ -26,7 +26,11 @@ from utils import as_rest_table CURRENT_DIR = os.path.dirname(os.path.abspath(__file__)) -HEADER = '.. NOTE: This file has been generated automatically, don\'t manually edit it' +HEADER = ''' +.. NOTE: This file has been generated automatically, don\'t manually edit it. + Edit st2common/st2common/constants/triggers.py and rebuild the + documentation. +'''.strip() def main(): @@ -44,9 +48,10 @@ def main(): rows.append(['Reference', 'Description', 'Properties']) for trigger_definition in trigger_definitions: + ref = '{pack}.{name}'.format(pack='core', name=trigger_definition['name']) properties = list(trigger_definition['payload_schema']['properties'].keys()) properties = ', '.join(properties) - row = [trigger_definition['name'], trigger_definition['description'], properties] + row = [ref, trigger_definition['description'], properties] rows.append(row) table = as_rest_table(rows, full=True)