[DOCS] Custom Actions

README.md

@@ -70,7 +70,7 @@ To ensure the long-term quality of the GX Core codebase, we're not yet ready to
 | -------------------- | ------------------ | ----- |
 | CredentialStore      | 🟢 Ready           |       |
 | BatchDefinition      | 🟡 Partially ready | Formerly known as splitters |
-| Action               | 🔴 Not ready       |       |
+| Action               | 🟢 Ready           |       |
 | DataSource           | 🔴 Not ready       | Includes MetricProvider and ExecutionEngine |
 | DataContext          | 🔴 Not ready       | Also known as Configuration Stores |
 | DataAsset            | 🔴 Not ready       |       |

docs/docusaurus/docs/application_integration_support.md

@@ -25,16 +25,17 @@ The following table defines the GX Cloud, GX Core, and Community Supported integ
 | Data Sources<sup>1</sup>         | Snowflake<br/>Databricks (SQL)<br/> PostgreSQL<sup>2</sup> | Snowflake<br/>Databricks (SQL)<br/>PostgreSQL<br/>SQLite<br/>BigQuery<br/>Spark<br/>Pandas | MSSQL<br/>MySQL<br/> |
 | Configuration Stores<sup>3</sup> | In-app                                                     | File system                                                                                | None                 |
 | Data Doc Stores                  | In-app                                                     | File system                                                                                | None                 |
-| Actions                          | Email                                                      | Slack <br/>Email <br/>Microsoft Teams                                                      | None                 |
-| Credential Stores                | Environment variables                                      | Environment variables <br/> YAML<sup>4</sup>                                               | None                 |
-| Orchestrator                     | Airflow <sup>5</sup> <sup>6</sup>                          | Airflow <sup>5</sup> <sup>6</sup>                                                          | None                 |
+| Actions                          | Email                                                      | Slack <br/>Email <br/>Microsoft Teams <br/>Custom<sup>4</sup>                              | None                 |
+| Credential Stores                | Environment variables                                      | Environment variables <br/> YAML<sup>5</sup>                                               | None                 |
+| Orchestrator                     | Airflow <sup>6</sup> <sup>7</sup>                          | Airflow <sup>6</sup> <sup>7</sup>                                                          | None                 |
 
 <sup>1</sup> We've also seen GX work with the following data sources in the past but we can't guarantee ongoing compatibility. These data sources include Clickhouse, Vertica, Dremio, Teradata, Athena, EMR Spark, AWS Glue, Microsoft Fabric, Trino, Pandas on (S3, GCS, Azure), Databricks (Spark), and Spark on (S3, GCS, Azure).<br/>
 <sup>2</sup> Support for BigQuery in GX Cloud will be available in a future release.<br/>
-<sup>3</sup> This includes configuration storage for Expectations, Checkpoints, Validation Definitions, and Validation Result<br/>
-<sup>4</sup> config_variables.yml<br/>
-<sup>5</sup> Although only Airflow is supported, GX Cloud and GX Core should work with any orchestrator that executes Python code.<br/>
-<sup>6</sup> Airflow version 2.9.0+ required<br/>
+<sup>3</sup> This includes configuration storage for Expectations, Checkpoints, Validation Definitions, and Validation Results.<br/>
+<sup>4</sup> We support the general workflow for creating custom Actions but cannot help troubleshoot the domain-specific logic within a custom Action.<br/>
+<sup>5</sup> Use `config_variables.yml`.<br/>
+<sup>6</sup> Although only Airflow is supported, GX Cloud and GX Core should work with any orchestrator that executes Python code.<br/>
+<sup>7</sup> Airflow version 2.9.0+ required.<br/>
 
 ### GX components
 

docs/docusaurus/docs/components/examples_under_test.py

@@ -439,6 +439,16 @@
         # data_context_dir="",
         backend_dependencies=[],
     ),
+    # Create a custom Action
+    IntegrationTestFixture(
+        # To test, run:
+        # pytest --docs-tests -k "docs_example_create_a_custom_action" tests/integration/test_script_runner.py
+        name="docs_example_create_a_custom_action",
+        user_flow_script="docs/docusaurus/docs/core/trigger_actions_based_on_results/_examples/create_a_custom_action.py",
+        data_dir="docs/docusaurus/docs/components/_testing/test_data_sets/single_test_file",
+        # data_context_dir="",
+        backend_dependencies=[],
+    ),
     # Run a Checkpoint
     IntegrationTestFixture(
         # To test, run:

docs/docusaurus/docs/core/trigger_actions_based_on_results/_examples/create_a_custom_action.py

@@ -0,0 +1,46 @@
+"""
+This is an example script for how to create a custom Action.
+
+To test, run:
+pytest --docs-tests -k "docs_example_create_a_custom_action" tests/integration/test_script_runner.py
+"""
+
+# EXAMPLE SCRIPT STARTS HERE:
+
+# <snippet name="docs/docusaurus/docs/core/trigger_actions_based_on_results/_examples/create_a_custom_action.py - full code example">
+
+from typing import Literal
+
+from typing_extensions import override
+
+from great_expectations.checkpoint.actions import ActionContext, ValidationAction
+from great_expectations.checkpoint.checkpoint import CheckpointResult
+
+
+# 1. Extend the `ValidationAction` class.
+# <snippet name="docs/docusaurus/docs/core/trigger_actions_based_on_results/_examples/create_a_custom_action.py - extend class">
+class MyCustomAction(ValidationAction):
+    # </snippet>
+
+    # 2. Set the `type` attribute to a unique string that identifies the Action.
+    # <snippet name="docs/docusaurus/docs/core/trigger_actions_based_on_results/_examples/create_a_custom_action.py - set type">
+    type: Literal["my_custom_action"] = "my_custom_action"
+    # </snippet>
+
+    # 3. Override the `run()` method to perform the desired task.
+    # <snippet name="docs/docusaurus/docs/core/trigger_actions_based_on_results/_examples/create_a_custom_action.py - override run">
+    @override
+    def run(
+        self,
+        checkpoint_result: CheckpointResult,
+        action_context: ActionContext,  # Contains results from prior Actions in the same Checkpoint run.
+    ) -> dict:
+        self._do_my_custom_action(...)  # Domain-specific logic
+        return {"some": "info"}  # Return information about the Action
+
+    def _do_my_custom_action(self): ...
+
+    # </snippet>
+
+
+# </snippet>

docs/docusaurus/docs/core/trigger_actions_based_on_results/create_a_checkpoint_with_actions.md

@@ -11,14 +11,14 @@ import PrereqValidationDefinition from '../_core_components/prerequisites/_valid
 
 A Checkpoint executes one or more Validation Definitions and then performs a set of Actions based on the Validation Results each Validation Definition returns.
 
-<h2>Prerequisites</h2>
+## Prerequisites
 
 - <PrereqPythonInstalled/>.
 - <PrereqGxInstalled/>.
 - <PrereqPreconfiguredDataContext/>. In this guide the variable `context` is assumed to contain your Data Context.
 - <PrereqValidationDefinition/>.
 
-### Procedure
+## Procedure
 
 <Tabs 
    queryString="procedure"
@@ -40,7 +40,7 @@ A Checkpoint executes one or more Validation Definitions and then performs a set
 
 2. Determine the Actions that the Checkpoint will automate.
 
-   After a Checkpoint receives Validation Results from running a Validation Definition, it executes a list of Actions. The returned Validation Results determine what task is performed for each Action. Actions can include updating Data Docs with the new Validation Results or sending alerts when validations fail.  The Actions list is executed once for each Validation Definition in a Checkpoint.
+   After a Checkpoint receives Validation Results from running a Validation Definition, it executes a list of Actions. The returned Validation Results determine what task is performed for each Action. Actions can include updating Data Docs with the new Validation Results, sending alerts when validations fail, or your own [custom logic](/core/trigger_actions_based_on_results/create_a_custom_action.md). The Actions list is executed once for each Validation Definition in a Checkpoint.
 
    Actions can be found in the `great_expectations.checkpoint` module.  All Action class names end with `*Action`.
 

docs/docusaurus/docs/core/trigger_actions_based_on_results/create_a_custom_action.md

@@ -0,0 +1,65 @@
+---
+title: Create a custom Action
+description: Run custom logic based on Validation Results to integrate with 3rd-party tools and business workflows.
+---
+import TabItem from '@theme/TabItem';
+import Tabs from '@theme/Tabs';
+
+import PrereqPythonInstalled from '../_core_components/prerequisites/_python_installation.md';
+import PrereqGxInstalled from '../_core_components/prerequisites/_gx_installation.md';
+
+Great Expectations provides [Actions for common workflows](/application_integration_support.md#integrations) such as sending emails and updating Data Docs. If these don't meet your needs, you can create a custom Action to integrate with different tools or apply custom business logic based on Validation Results. Example use cases for custom Actions include:
+- Opening tickets in an issue tracker when Validation runs fail.
+- Sending emails to different teams depending on which Expectations fail.
+- Running follow-up ETL jobs to fill in missing values.  
+
+A custom Action can do anything that can be done with Python code.
+
+To create a custom Action, you subclass the `ValidationAction` class, overriding the `type` attribute with a unique name and the `run()` method with custom logic.
+
+
+## Prerequisites
+
+- <PrereqPythonInstalled/>.
+- <PrereqGxInstalled/>.
+
+## Procedure
+
+<Tabs 
+   queryString="procedure"
+   defaultValue="instructions"
+   values={[
+      {value: 'instructions', label: 'Instructions'},
+      {value: 'sample_code', label: 'Sample code'}
+   ]}
+>
+
+<TabItem value="instructions" label="Instructions">
+
+1. Create a new custom Action class that inherits the `ValidationAction` class.
+
+   ```python title="Python" name="docs/docusaurus/docs/core/trigger_actions_based_on_results/_examples/create_a_custom_action.py - extend class" 
+   ```
+
+2. Set a unique name for `type`.
+
+   ```python title="Python" name="docs/docusaurus/docs/core/trigger_actions_based_on_results/_examples/create_a_custom_action.py - set type" 
+   ```
+
+3. Override the `run()` method with the logic for the Action.
+
+   ```python title="Python" name="docs/docusaurus/docs/core/trigger_actions_based_on_results/_examples/create_a_custom_action.py - override run" 
+   ```
+
+</TabItem>
+
+<TabItem value="sample_code" label="Sample code">
+
+```python title="Python" name="docs/docusaurus/docs/core/trigger_actions_based_on_results/_examples/create_a_custom_action.py - full code example" 
+```
+
+</TabItem>
+
+</Tabs>
+
+Now you can use your custom Action like you would any built-in Action. [Create a Checkpoint with Actions](/core/trigger_actions_based_on_results/create_a_checkpoint_with_actions.md) to start automating responses to Validation Results.

docs/docusaurus/docs/core/trigger_actions_based_on_results/trigger_actions_based_on_results.md

@@ -23,6 +23,14 @@ import OverviewCard from '@site/src/components/OverviewCard';
     to="/core/trigger_actions_based_on_results/create_a_checkpoint_with_actions" 
     icon="/img/expectation_icon.svg" 
   />
+
+  <LinkCard 
+    topIcon 
+    label="Create a custom Action"
+    description="Define custom logic to run based on Validation Results."
+    to="/core/trigger_actions_based_on_results/create_a_custom_action" 
+    icon="/img/expectation_icon.svg" 
+  />
 
   <LinkCard 
     topIcon 

docs/docusaurus/sidebars.js

@@ -108,6 +108,7 @@ module.exports = {
       link: { type: 'doc', id: 'core/trigger_actions_based_on_results/trigger_actions_based_on_results' },
       items: [
         { type: 'doc', id: 'core/trigger_actions_based_on_results/create_a_checkpoint_with_actions' },
+        { type: 'doc', id: 'core/trigger_actions_based_on_results/create_a_custom_action' },
         { type: 'doc', id: 'core/trigger_actions_based_on_results/choose_a_result_format/choose_a_result_format' },
         { type: 'doc', id: 'core/trigger_actions_based_on_results/run_a_checkpoint' },
       ]

great_expectations/checkpoint/actions.py

@@ -182,10 +182,10 @@ def __new__(cls, clsname, bases, attrs):
 @public_api
 class ValidationAction(BaseModel, metaclass=MetaValidationAction):
     """
-    ValidationActions define a set of steps to be run after a validation result is produced.
+    Actions define a set of steps to run after a Validation Result is produced. Subclass `ValidationAction` to create a `custom Action </docs/core/trigger_actions_based_on_results/create_a_custom_action>`_.
 
     Through a Checkpoint, one can orchestrate the validation of data and configure notifications, data documentation updates,
-    and other actions to take place after the validation result is produced.
+    and other actions to take place after the Validation Result is produced.
     """  # noqa: E501
 
     class Config: