Skip to content

deps(executors): bump version and document config / workflow #432

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.

Sign up for GitHub

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

Merged
AndreyMarkinPPC merged 1 commit into from
May 13, 2026
+20 −2
Merged

deps(executors): bump version and document config / workflow #432

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions docs/usage/configs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,9 @@ Configs are defined in YAML files. The core structure consists of a two elements
source in `sources`.

```yaml
name: config_name
metadata:
version: '0.0.0'
sources:
source-alias:
writer: bq
Expand All @@ -27,6 +30,8 @@ global_parameters:

where:

* **name**: Optional config name.
* **metadata**: Optional metadata on config (version, description).
* **source-alias**: The source of data. Check [available fetchers](../fetchers/overview.md).
* **fetcher_parameters**: Key value pairs used to fine-tune fetching process.
* **writer**: Where the data should be saved. Check [available writers](writers.md).
Expand Down
15 changes: 14 additions & 1 deletion docs/usage/workflows.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,16 @@ where each step interacts with a specific data source (fetcher) and writes to a
Workflows are defined in YAML files. The core structure consists of a list of
`steps`, where each step defines what data to fetch and where to save it.

### Workflow Step Structure
### Workflow Structure

```yaml
name: test_workflow
metadata:
description: Test workflow description
version: '0.0.0'
required_garf_version: ""
required_fetchers:
garf-google-ads: "1.0.0"
steps:
- alias: step_name
fetcher: source_name
Expand All @@ -40,6 +47,12 @@ steps:

### Components

* **name**: Optional name of the workflow
* **metadata**: Optional metadata for the workflow.
* **description**: Short description of the workflow.
* **version**: Version of the workflow.
* **required_garf_version**: Minimal required version of garf-executors library.
* **required_fetchers**: Required fetchers and their version.
* **fetcher**: The source of data. Check [available fetchers](../fetchers/overview.md).
* **fetcher_parameters**: Key value pairs used to fine-tune fetching process.
* **alias**: A unique identifier for the step. Useful for logging and [selective execution](#selective-execution).
Expand Down
2 changes: 1 addition & 1 deletion libs/executors/garf/executors/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,4 +21,4 @@
'ApiQueryExecutor',
]

__version__ = '1.4.2'
__version__ = '1.4.3'
Loading