Skip to content

Document st2.action.file_writen trigger rename #995

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
blag merged 5 commits into from
Jul 25, 2020
Merged

Document st2.action.file_writen trigger rename #995

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
984fbf8
Document st2.action.file_writen trigger rename
blag Jul 14, 2020
a36292a
Fix script to properly generate trigger *references*
blag Jul 14, 2020
dfbc994
Merge branch 'master' into fix-writen-typo
blag Jul 21, 2020
e08833d
Merge branch 'master' into fix-writen-typo
blag Jul 23, 2020
de431c2
Merge branch 'master' into fix-writen-typo
blag Jul 24, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions docs/source/upgrade_notes.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
9 changes: 7 additions & 2 deletions scripts/generate-internal-triggers-table.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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():
Expand All @@ -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)
Expand Down