Skip to content

Docs: Fix inconsistency in documents when using BashOperator with Jinja templating#64129

Merged
potiuk merged 1 commit intoapache:mainfrom
sjyangkevin:fix-bash-operator-documentation
Mar 24, 2026
Merged

Docs: Fix inconsistency in documents when using BashOperator with Jinja templating#64129
potiuk merged 1 commit intoapache:mainfrom
sjyangkevin:fix-bash-operator-documentation

Conversation

@sjyangkevin
Copy link
Contributor

Why

The BashOperator document has a warning about passing dag_run.conf directly into the bash_command. This usage is not suggested. However, in the Core Concepts - Dag Run document, the example use the pattern that is not recommended, which is an inconsistency. This PR fixes this by updating the example in the Core Concepts -Dag Run document.

BashOperator Document

Screenshot from 2026-03-23 22-25-46

Core Concepts - Dag Run Document

Screenshot from 2026-03-23 22-26-51
Was generative AI tooling used to co-author this PR?
  • Yes (please specify the tool below)

  • Read the Pull Request Guidelines for more information. Note: commit author/co-author name and email in commits become permanently public when merged.
  • For fundamental code changes, an Airflow Improvement Proposal (AIP) is needed.
  • When adding dependency, check compliance with the ASF 3rd Party License Policy.
  • For significant user-facing changes create newsfragment: {pr_number}.significant.rst, in airflow-core/newsfragments. You can add this file in a follow-up commit after the PR is created so you know the PR number.

@sjyangkevin sjyangkevin marked this pull request as ready for review March 24, 2026 02:57
@sjyangkevin sjyangkevin changed the title Docs: Fix inconsistency in documents in using BashOperator with Jinja templating Docs: Fix inconsistency in documents when using BashOperator with Jinja templating Mar 24, 2026
@potiuk potiuk merged commit af4f825 into apache:main Mar 24, 2026
134 checks passed
@potiuk potiuk added the backport-to-v3-1-test Mark PR with this label to backport to v3-1-test branch label Mar 24, 2026
@potiuk potiuk added this to the Airflow 3.1.9 milestone Mar 24, 2026
potiuk pushed a commit that referenced this pull request Mar 24, 2026
…nsistent with BashOperator document (#64129)

(cherry picked from commit af4f825)

Co-authored-by: Kevin Yang <85313829+sjyangkevin@users.noreply.github.com>
potiuk added a commit that referenced this pull request Mar 24, 2026
…nsistent with BashOperator document (#64129) (#64140)

(cherry picked from commit af4f825)

Co-authored-by: Kevin Yang <85313829+sjyangkevin@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

backport-to-v3-1-test Mark PR with this label to backport to v3-1-test branch kind:documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants