Skip to content

Commit

Permalink
digraph: Support DAG_NAME and DAG_STEP_NAME special environment v…
Browse files Browse the repository at this point in the history
…ariables (#764)
  • Loading branch information
yottahmd authored Jan 1, 2025
1 parent ed3f4ab commit 908bf62
Show file tree
Hide file tree
Showing 35 changed files with 1,563 additions and 403 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ A powerful, self-contained Cron alternative with a clean Web UI and a [declarati
- Redirection of stdout and stderr
- Lifecycle hooks (on failure, on exit, etc.)
- Repeating tasks, automatic/manual retry
- Run sub-DAGs
- Run sub workflows
- Handy built-in executors:
- Docker containers
- HTTP requests
Expand Down Expand Up @@ -249,7 +249,7 @@ remoteNodes:
- [Redirecting Stdout and Stderr](https://dagu.readthedocs.io/en/latest/yaml_format.html#redirecting-stdout-and-stderr)
- [Lifecycle Hooks](https://dagu.readthedocs.io/en/latest/yaml_format.html#adding-lifecycle-hooks)
- [Repeating Task](https://dagu.readthedocs.io/en/latest/yaml_format.html#repeating-a-task-at-regular-intervals)
- [Running Sub-DAG](https://dagu.readthedocs.io/en/latest/yaml_format.html#running-sub-dag)
- [Running Sub-workflow](https://dagu.readthedocs.io/en/latest/yaml_format.html#running-sub-dag)
- [All Available Fields for a DAG](https://dagu.readthedocs.io/en/latest/yaml_format.html#all-available-fields-for-dags)
- [All Available Fields for a Step](https://dagu.readthedocs.io/en/latest/yaml_format.html#all-available-fields-for-steps)
- Example DAGs
Expand Down
13 changes: 7 additions & 6 deletions docs/source/examples.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,14 +11,15 @@ Hello World

.. code-block:: yaml
name: hello world
params:
- NAME: "Dagu"
steps:
- name: s1
command: echo hello world
- name: s2
command: echo done!
- name: Hello world
command: echo Hello $NAME
- name: Done
command: echo Done!
depends:
- s1
- Hello world
Conditional Steps
Expand Down
7 changes: 6 additions & 1 deletion docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Dagu
:alt: Dew overview
:width: 800px

Dagu is a powerful Cron alternative that comes with a Web UI. It allows you to define dependencies between commands in a declarative :ref:`YAML Format`. Additionally, Dagu natively supports running Docker containers, making HTTP requests, and executing commands over SSH. Dagu was designed to be easy to use, self-contained, and require no coding, making it ideal for small projects.
A powerful, self-contained Cron alternative with a clean Web UI and a `declarative YAML-based workflow definition <https://dagu.readthedocs.io/en/latest/yaml_format.html>`_. Dagu simplifies complex job dependencies and scheduling with minimal overhead.

Quick Start
------------
Expand All @@ -37,10 +37,14 @@ Quick Start

:ref:`Examples`
Examples of DAGs.
Writing DAGs.

:ref:`Configuration Options`
Configuration options.

:ref:`schema-reference`
Schema reference.

.. toctree::
:caption: Installation
:hidden:
Expand All @@ -65,6 +69,7 @@ Quick Start
base_config
examples
special_env
schema

.. toctree::
:caption: Configuration
Expand Down
Loading

0 comments on commit 908bf62

Please sign in to comment.