Skip to content
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.

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

Deprecation notice for {{user}} and {{system}} #367

Merged
merged 4 commits into from Feb 9, 2017
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
5 changes: 2 additions & 3 deletions docs/source/datastore.rst
Expand Up @@ -111,9 +111,8 @@ or simply:

This variable won't clash with the user variables under same name. Also, you can refer
to user variables in actions or workflows. The jinja syntax to do so is
``{{st2kv.user.date_cmd}}``. Until v2.1, this expression used to be ``{{user.date_cmd}}``. For
backward compatibility, the older expression is still supported but will be deprecated in subsequent
releases.
``{{st2kv.user.date_cmd}}``. Until v2.1, this expression used to be ``{{user.date_cmd}}``
but is now deprecated.

Note that the notion of ``st2kv.user`` is available only when actions
or workflows are run manually. The notion of ``st2kv.user`` is non-existent when automations
Expand Down
7 changes: 3 additions & 4 deletions docs/source/reference/jinja.rst
Expand Up @@ -13,10 +13,9 @@ For brevity, the jinja patterns are only documented. Usage of these patterns ins
Accessing datastore items with Jinja
------------------------------------

You can use ``{{st2kv.system.foo}}`` to access key ``foo`` from datastore. Note that until v2.1,
the expression to access key ``foo`` from datastore used to be ``{{system.foo}}``.
Though the older jinja expression is still supported, we'd be deprecating that usage
in subsequent releases.
You can use ``{{st2kv.system.foo}}`` to access key ``foo`` from datastore. Note that until
v2.1, the expression to access key ``foo`` from datastore used to be ``{{system.foo}}``
but is now deprecated.

.. _applying-filters-with-jinja:

Expand Down
5 changes: 5 additions & 0 deletions docs/source/upgrade_notes.rst
Expand Up @@ -34,6 +34,11 @@ Upgrade Notes
executions_v2, either use psql or install an older version of the python-mistralclient in a
separate python virtual environment.

* Jinja notations ``{{user.key}}`` and ``{{system.key}}`` to access datastore items under
``user`` and ``system`` scopes are now deprecated. Please use ``{{st2kv.user.key}}`` and
``{{st2kv.system.key}}`` notations instead.


Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Extra line break :P

|st2| v2.1
----------

Expand Down