Skip to main content
Version: 1.0 prerelease

UpdateDataDocsAction

class great_expectations.checkpoint.UpdateDataDocsAction(*, type: Literal['update_data_docs'] = 'update_data_docs', name: str, notify_on: Literal['all', 'failure', 'success'] = 'all', site_names: List[str] = [])#

Notify the site builders of all data docs sites of a Data Context that a validation result should be added to the data docs.

YAML configuration example:

- name: update_data_docs
action:
class_name: UpdateDataDocsAction

You can also instruct UpdateDataDocsAction to build only certain sites by providing a site_names key with a list of sites to update:

- name: update_data_docs
action:
class_name: UpdateDataDocsAction
site_names:
- local_site

Parameters:

site_names – Optional. A list of the names of sites to update.