This is an automated email from the ASF dual-hosted git repository.
kaxil pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/airflow.git
The following commit(s) were added to refs/heads/main by this push:
new 4c29b3beb43 Fix outdated commands and references in contributing docs
(#75294)
4c29b3beb43 is described below
commit 4c29b3beb4353b38780396aab977102128073bc1
Author: W. H. Wang <[email protected]>
AuthorDate: Wed Oct 21 20:01:04 2026 +0800
Fix outdated commands and references in contributing docs (#75294)
- 20_debugging_airflow_components.rst: breeze start-airflow defaults to
mprocs, and --use-mprocs does not exist; use --terminal-multiplexer.
- 26_migration_round_trip_check.rst: the Migration round-trip check job
lives in ci-amd.yml and ci-arm.yml, not the non-existent ci-amd-arm.yml.
- testing/unit_tests.rst: the "Keep tests using environment variables"
example used --no-db-cleanup instead of --keep-env-variables.
---
contributing-docs/20_debugging_airflow_components.rst | 14 +++++++-------
contributing-docs/26_migration_round_trip_check.rst | 4 ++--
contributing-docs/testing/unit_tests.rst | 2 +-
3 files changed, 10 insertions(+), 10 deletions(-)
diff --git a/contributing-docs/20_debugging_airflow_components.rst
b/contributing-docs/20_debugging_airflow_components.rst
index d7798baab1e..c2b5610a709 100644
--- a/contributing-docs/20_debugging_airflow_components.rst
+++ b/contributing-docs/20_debugging_airflow_components.rst
@@ -69,19 +69,19 @@ Breeze supports two debugger options:
# Use PyCharm debugger
breeze start-airflow --debug scheduler --debugger pydevd-pycharm
-Using mprocs Instead of tmux
------------------------------
+Choosing between mprocs and tmux
+--------------------------------
-By default, ``breeze start-airflow`` uses tmux to manage multiple Airflow
components. You can use
-mprocs as an alternative process manager with the ``--use-mprocs`` flag:
+By default, ``breeze start-airflow`` uses mprocs to manage multiple Airflow
components. You can
+switch to tmux with the ``--terminal-multiplexer`` flag. Breeze remembers your
choice for later runs:
.. code-block:: bash
- # Use mprocs instead of tmux
- breeze start-airflow --use-mprocs
+ # Use tmux instead of mprocs
+ breeze start-airflow --terminal-multiplexer tmux
# Use mprocs with debugging
- breeze start-airflow --use-mprocs --debug scheduler --debug triggerer
+ breeze start-airflow --terminal-multiplexer mprocs --debug scheduler
--debug triggerer
**Benefits of mprocs:**
diff --git a/contributing-docs/26_migration_round_trip_check.rst
b/contributing-docs/26_migration_round_trip_check.rst
index 1f5052c43fd..bf9ab9bf35c 100644
--- a/contributing-docs/26_migration_round_trip_check.rst
+++ b/contributing-docs/26_migration_round_trip_check.rst
@@ -47,8 +47,8 @@ it manually:
CI runs it automatically on any pull request whose changed files
include ``airflow-core/src/airflow/migrations/`` — the dedicated
-``Migration round-trip check`` job in ``.github/workflows/ci-amd-arm.yml``
-is gated on the ``has-migrations`` selective-checks output.
+``Migration round-trip check`` job in ``.github/workflows/ci-amd.yml`` and
+``.github/workflows/ci-arm.yml`` is gated on the ``has-migrations``
selective-checks output.
Convention: ``disable_sqlite_fkeys`` placement
diff --git a/contributing-docs/testing/unit_tests.rst
b/contributing-docs/testing/unit_tests.rst
index 4a44ac5f664..c801cd84c33 100644
--- a/contributing-docs/testing/unit_tests.rst
+++ b/contributing-docs/testing/unit_tests.rst
@@ -1576,7 +1576,7 @@ a pytest CLI argument.
.. code-block:: bash
- pytest airflow-core/tests/unit/core/ --no-db-cleanup
+ pytest airflow-core/tests/unit/core/ --keep-env-variables
This parameter is also available in Breeze.
