Globus-automate-client

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

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

- Add the ``"notify_on_*"`` parameters to the transfer action provider JSON example.

- The description of the Action polling policy has been updated and a discussion of how caching of token validation checks may impact users who invalidate their tokens has been added.

- Adds an input schema for the example single-transfer Flow definition.

- Add documentation for `globus-collection-id` and `globus-collection-path` formats

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

Bugfixes
--------

- Fix a ``KeyError`` crash that occurs when enabling verbose output using the ``-v`` argument. (111)
- Fix a ``ValueError`` crash that occurs when displaying a flow. (110)

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

Features
--------

- Upgrade to Globus SDK v3.

Bugfixes
--------

- Fixes a bug in the SDK that prevented Flow updates from removing all
flow_administrators, flow_viewers, and flow_starters. This bug also
prevented updates from setting text fields to empty strings.

- Fix a bug that could allow the Flows authorizer to be lost if an exception
was raised. (Authorizer swaps are now handled using a context manager.)

- Support strings (and tuples/sets containing strings) as argument values
when running, deploying, or updating an action or a flow and specifying
a keyword argument alias like ``visible_to`` or ``runnable_by``.

Other
-----

- Add code linting, documentation build testing, and a bunch of unit tests.
- Add GitHub Actions to run on push and pull requests.
- Add a pre-commit configuration file to increase overall code quality.

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

Bugfixes
--------

- Fix a bug that prevented the Flows client from properly validating flow definition states in lists.
- Prevent empty values from appearing in query parameters or JSON submissions.
- Fix a bug that prevented the input schema of an existing Flow from being set to an all-permissive JSON schema.
- Fix a bug that prevented a custom authorizer from being used if attempting to list all runs of a specific flow without specifying the flow ID.
- Fix a bug that introduced duplicate forward slashes in some API URL's.

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

- Add a CHANGELOG and include it in the documentation.
- Use scriv for CHANGELOG management.

- Added documentation for the new Action Providers for:
- Make a directory via Globus Transfer (mkdir)
- Get collection information via Globus Transfer (collection_info)
- Added documentation for new feature of the list directory Action Provider to get information only about the path provided as input

- Added documentation related to use of built-in functions in expressions. Documented the new functions ``pathsplit``, ``is_present`` and ``getattr``.

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

Features
--------

- The output of globus-automate flow list is modified to ensure that the Flow ID is always visible.
The new output search is similar to the output of ``globus endpoint search``.
- The output when watching the results of a ``globus-automate flow run`` now defaults to table view.

Bugfixes
--------

- Fixes an infinite loop when watching the output of ``flow action-log``/``flow run-log`` with the ``--reverse`` flag.
- Fixes the limit minimum level from 0 to 1 when doing ``flow action-log``/``flow run-log`` to prevent server errors.
- Fixes a bug where an unsafe indexing operation was being made during ``flow action-list``/``flow run-list``

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

- CLI documentation is updated to more precisely reflect that ``--label`` is a required property when running a Flow.

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

Features
--------

- CLI commands which output lists of data now display a subset of the data fields as a table.
For access to the full data or to access data in JSON or YAML format, the ``-f json | yaml`` option may be used.
The tabular output is on the following commands:
- ``globus-automate flow list``
- ``globus-automate flow action-list ...``
- ``globus-automate flow action-enumerate ...``
- ``globus-automate flow action-log ...``
- File inputs to CLI commands may now be in either JSON or YAML formatting without the need to specify the input file format.

Bugfixes
--------

- Fixed an error where the output of the ``globus-automate flow update`` command displayed unformatted JSON

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

- Added text explaining that the Fail state is a supported state type and can be used in Flows.
A simple example using the Fail state is included in the examples directory for the repository.