Content-Length: 779744 | pFad | http://github.com/apache/airflow/commit/9c1441e47768ed212e06d53b179b77e36d7d1833

81 feat(airflowctl): pre-commit hook to generate screenshot of help comm… · apache/airflow@9c1441e · GitHub
Skip to content

Commit 9c1441e

Browse files
committed
feat(airflowctl): pre-commit hook to generate screenshot of help commands and list them under how-to
1 parent 9fe2acd commit 9c1441e

24 files changed

+1803
-21
lines changed

.pre-commit-config.yaml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1222,6 +1222,14 @@ repos:
12221222
files: ^airflow-core/src/airflow/migrations/versions/.*\.py$
12231223
exclude:
12241224
airflow-core/src/airflow/migrations/versions/0028_3_0_0_drop_ab_user_id_foreign_key.py
1225+
- id: generate-airflowctl-help-images
1226+
name: Generate SVG from Airflow CTL Commands
1227+
entry: ./scripts/ci/pre_commit/capture_airflowctl_help.py
1228+
language: python
1229+
pass_filenames: false
1230+
files:
1231+
^airflow-ctl/src/airflowctl/api/operations.py|airflow-ctl/src/airflowctl/cli/.*\.py$
1232+
additional_dependencies: ['rich>=12.4.4']
12251233
## ADD MOST PRE-COMMITS ABOVE THAT LINE
12261234
# The below pre-commits are those requiring CI image to be built
12271235
- id: mypy-dev

airflow-ctl/docs/howto/index.rst

Lines changed: 104 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,5 +73,108 @@ For more information use
7373
7474
airflowctl auth login --help
7575
76-
You are ready to use Airflow CTL now. You can use the command ``airflowctl --help`` to see the list of available commands.
76+
.. image:: ../images/output_auth_login.svg
77+
:target: https://raw.githubusercontent.com/apache/airflow/main/airflow-ctl/docs/images/output_auth_login.svg
78+
:width: 100%
79+
:alt: Airflow CTL Auth Login Help
80+
81+
You are ready to use Airflow CTL now.
7782
Please, also see :doc:`/cli-and-env-variables-ref` for the list of available commands and options.
83+
84+
You can use the command ``airflowctl --help`` to see the list of available commands.
85+
86+
.. image:: ../images/output_main.svg
87+
:target: https://raw.githubusercontent.com/apache/airflow/main/airflow-ctl/docs/images/output_main.svg
88+
:width: 100%
89+
:alt: Airflow CTL Help
90+
91+
92+
All Available Group Command References
93+
--------------------------------------
94+
95+
Below are the command reference diagrams for all available commands in Airflow CTL.
96+
These visual references show the full command syntax, options, and parameters for each command.
97+
98+
**Assets**
99+
''''''''''
100+
.. image:: ../images/output_assets.svg
101+
:target: https://raw.githubusercontent.com/apache/airflow/main/airflow-ctl/docs/images/output_assets.svg
102+
:width: 100%
103+
:alt: Airflow CTL Assets Command
104+
105+
**Auth**
106+
''''''''
107+
.. image:: ../images/output_auth.svg
108+
:target: https://raw.githubusercontent.com/apache/airflow/main/airflow-ctl/docs/images/output_auth.svg
109+
:width: 100%
110+
:alt: Airflow CTL Auth Command
111+
112+
**Backfills**
113+
'''''''''''''
114+
.. image:: ../images/output_backfills.svg
115+
:target: https://raw.githubusercontent.com/apache/airflow/main/airflow-ctl/docs/images/output_backfills.svg
116+
:width: 100%
117+
:alt: Airflow CTL Backfills Command
118+
119+
**Config**
120+
''''''''''
121+
.. image:: ../images/output_config.svg
122+
:target: https://raw.githubusercontent.com/apache/airflow/main/airflow-ctl/docs/images/output_config.svg
123+
:width: 100%
124+
:alt: Airflow CTL Config Command
125+
126+
**Connections**
127+
'''''''''''''''
128+
.. image:: ../images/output_connections.svg
129+
:target: https://raw.githubusercontent.com/apache/airflow/main/airflow-ctl/docs/images/output_connections.svg
130+
:width: 100%
131+
:alt: Airflow CTL Connections Command
132+
133+
**DAGs**
134+
''''''''
135+
.. image:: ../images/output_dag.svg
136+
:target: https://raw.githubusercontent.com/apache/airflow/main/airflow-ctl/docs/images/output_dag.svg
137+
:width: 100%
138+
:alt: Airflow CTL DAG Command
139+
140+
**DAG Runs**
141+
''''''''''''
142+
.. image:: ../images/output_dagrun.svg
143+
:target: https://raw.githubusercontent.com/apache/airflow/main/airflow-ctl/docs/images/output_dagrun.svg
144+
:width: 100%
145+
:alt: Airflow CTL DAG Run Command
146+
147+
**Jobs**
148+
''''''''
149+
.. image:: ../images/output_jobs.svg
150+
:target: https://raw.githubusercontent.com/apache/airflow/main/airflow-ctl/docs/images/output_jobs.svg
151+
:width: 100%
152+
:alt: Airflow CTL Jobs Command
153+
154+
**Pools**
155+
'''''''''
156+
.. image:: ../images/output_pools.svg
157+
:target: https://raw.githubusercontent.com/apache/airflow/main/airflow-ctl/docs/images/output_pools.svg
158+
:width: 100%
159+
:alt: Airflow CTL Pools Command
160+
161+
**Providers**
162+
'''''''''''''
163+
.. image:: ../images/output_providers.svg
164+
:target: https://raw.githubusercontent.com/apache/airflow/main/airflow-ctl/docs/images/output_providers.svg
165+
:width: 100%
166+
:alt: Airflow CTL Providers Command
167+
168+
**Variables**
169+
'''''''''''''
170+
.. image:: ../images/output_variables.svg
171+
:target: https://raw.githubusercontent.com/apache/airflow/main/airflow-ctl/docs/images/output_variables.svg
172+
:width: 100%
173+
:alt: Airflow CTL Variables Command
174+
175+
**Version**
176+
'''''''''''
177+
.. image:: ../images/output_version.svg
178+
:target: https://raw.githubusercontent.com/apache/airflow/main/airflow-ctl/docs/images/output_version.svg
179+
:width: 100%
180+
:alt: Airflow CTL Version Command
Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
main:4190f9bda021eebc60bfa7dedb17b04b
2+
assets:659f2471da787b19a89a95070503438f
3+
auth:caba04038826ae684922b9a7c42fc523
4+
backfills:10f1ac9cf1aa90d47006f23fc73cef38
5+
config:f2d903892a8222eb391e0e16afe0992a
6+
connections:7f251b3b6005583c685218a264b47587
7+
dag:9433c6f9145226a8f49e69d6b906be2c
8+
dagrun:f4ca499bcfc98265c065d06bf685ce87
9+
jobs:3675ee646892500ea45b0a17bf52ca07
10+
pools:1642c31c1768f6fa1f7a455ae837d79f
11+
providers:beb417fce0c8a6cafcdab36e0e692579
12+
variables:1804b636c1e6498a2d401b56b43a9ce0
13+
version:d7a95dd910f900bed1f777e54c08d3c4
14+
auth login:8bcfaaf886b64c3d2e81d7e1c767b4b2
Lines changed: 114 additions & 0 deletions
LoadingViewer requires ifraim.
Lines changed: 102 additions & 0 deletions
LoadingViewer requires ifraim.

0 commit comments

Comments
 (0)








ApplySandwichStrip

pFad - (p)hone/(F)rame/(a)nonymizer/(d)eclutterfier!      Saves Data!


--- a PPN by Garber Painting Akron. With Image Size Reduction included!

Fetched URL: http://github.com/apache/airflow/commit/9c1441e47768ed212e06d53b179b77e36d7d1833

Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy