Globus-automate-client

===================

Bugfixes
--------

- Update pyyaml to 6.0.1 in order to resolve build issues related to Cython 3.

.. _changelog-0.17.0:

===================

Features
--------

- Add official support for python3.11

- Support retrieval of the flow definition and input schema used to start a run.

This is supported in the new ``flow run-definition`` subcommand.

Bugfixes
--------

- Fix a bug which could lead to improper handling of token refreshes

- `[sc-19291] <https://app.shortcut.com/globus/story/19291>`_
Prevent passive flow permission updates.

Previously, permissions were erased during updates if no permissions were specified.
Now, permissions will only be erased if an empty string is passed. For example:

.. code-block:: text

Erase all viewer permissions.
globus-automate flow update $UUID --flow-viewer=""

Documentation
-------------

- Fix example flow definition web-option-with-parameters

- Improve documentation by normalizing capitalization and emphasis, as well as
clarifying usage of "Globus Automate" wherever it occurred.

- Add simplified versions of our production flows as inline examples on the
"Authoring Flows" page.

.. _changelog-0.16.1.post1:

=========================

Documentation
-------------

- `[sc-16711] <https://app.shortcut.com/globus/story/16711>`_
Document how to automatically run a flow based on filesystem change events.

.. _changelog-0.16.1:

===================

Bugfixes
--------

- Fix a bug in the flow administrator/starter/runner CLI alias validation
which prevents successfully running the ``flow update`` subcommand.

.. _changelog-0.16.0:

===================

Changes
-------

- `[sc-13892] <https://app.shortcut.com/globus/story/13892>`_
Standardize flow viewer, starter, and administrator arguments -- and their aliases -- throughout the CLI and API.

Although this change fixes bugs that prevented documented CLI options from working,
it also introduces breaking changes:

* ``--flow-viewer``, ``--flow-starter``, and ``--flow-administrator`` are the canonical CLI options.
* The CLI option aliases will continue to work, but the alias behavior has changed:

* If an alias is used, a warning is written to STDERR.
* If the canonical option name is combined with one of its aliases,
an error will be written to STDERR and the Automate client will exit.
The exit code will be 1.
* If more than one of the acceptable aliases is used (like ``--starter`` and ``--runnable-by``),
an error will be written to STDERR and the Automate client will exit.
The exit code will be 1.

In addition, there are breaking changes in the API:

* ``flow_viewers``, ``flow_starters``, and ``flow_administrators`` are the canonical API argument names.
* The API argument aliases will continue to work, but the alias behavior has changed:

* If an alias is used, a Python warning will be issued.
Applications can control the warning behavior using Python's ``warnings`` module.
* If the canonical option name is combined with one of its aliases, a ``ValueError`` will be raised.
* If more than one of the acceptable aliases is used (like ``starters`` and ``runnable_by``), a ``ValueError`` will be raised.

Bugfixes
--------

- Update pyjwt to version 2.4.0 to address
`CVE-2022-29217 <https://nvd.nist.gov/vuln/detail/CVE-2022-29217>`_.

.. _changelog-0.15.2:

===================

- `[sc-16137] <https://app.shortcut.com/globus/story/16137>`_
Fix flows run dry-run URL path

.. _changelog-0.15.1: