Skip to content
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.

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

Disable rendering for doc_md #40522

Merged
merged 1 commit into from
Jul 2, 2024

Conversation

Lee-W
Copy link
Member

@Lee-W Lee-W commented Jul 1, 2024


^ Add meaningful description above
Read the Pull Request Guidelines for more information.
In case of fundamental code changes, an Airflow Improvement Proposal (AIP) is needed.
In case of a new dependency, check compliance with the ASF 3rd Party License Policy.
In case of backwards incompatible changes please leave a note in a newsfragment file, named {pr_number}.significant.rst or {issue_number}.significant.rst, in newsfragments.

@Lee-W Lee-W requested review from kaxil, XD-DENG and ashb as code owners July 1, 2024 14:56
airflow/models/dag.py Outdated Show resolved Hide resolved
Copy link
Member

@hussein-awala hussein-awala left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

IMHO we should add a condition for file paths, like reading the file without render the content

if doc_md.endswith(".md"):
    return open(doc_md, "r").read()

with a try/except in case the file is not found.

@Lee-W Lee-W force-pushed the disable-rendering-for-doc-md branch from f6f0110 to e4d7197 Compare July 1, 2024 15:28
airflow/models/dag.py Outdated Show resolved Hide resolved
Copy link
Contributor

@amoghrajesh amoghrajesh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@Lee-W Lee-W force-pushed the disable-rendering-for-doc-md branch from e4d7197 to 90109c0 Compare July 2, 2024 02:49
@Lee-W Lee-W force-pushed the disable-rendering-for-doc-md branch from 90109c0 to 732a0e2 Compare July 2, 2024 03:42
@Lee-W
Copy link
Member Author

Lee-W commented Jul 2, 2024

Changed a test case after approval. I'm planning on merging this late too night. Please let me know if anyone want to take a look

@potiuk potiuk added this to the Airflow 2.9.3 milestone Jul 2, 2024
@potiuk
Copy link
Member

potiuk commented Jul 2, 2024

LGTM. Marked it as 2.9.3

@ephraimbuddy ephraimbuddy merged commit 8159f6e into apache:main Jul 2, 2024
52 checks passed
@ephraimbuddy ephraimbuddy deleted the disable-rendering-for-doc-md branch July 2, 2024 09:04
utkarsharma2 pushed a commit that referenced this pull request Jul 2, 2024
ephraimbuddy pushed a commit that referenced this pull request Jul 2, 2024
@utkarsharma2 utkarsharma2 added the type:bug-fix Changelog: Bug Fixes label Jul 12, 2024
romsharon98 pushed a commit to romsharon98/airflow that referenced this pull request Jul 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type:bug-fix Changelog: Bug Fixes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants