You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@airflow.apache.org by "Lohith625 (via GitHub)" <gi...@apache.org> on 2025/11/09 03:00:24 UTC
[PR] Docs: update UIAlert import path and usage for v3 (#58089) [airflow]
Lohith625 opened a new pull request, #58090:
URL: https://github.com/apache/airflow/pull/58090
<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
-->
<!--
Thank you for contributing! Please make sure that your code changes
are covered with tests. And in case of new features or big changes
remember to adjust the documentation.
Feel free to ping committers for the review!
In case of an existing issue, reference it using one of the following:
closes: #ISSUE
related: #ISSUE
How to write a good git commit message:
http://chris.beams.io/posts/git-commit/
-->
<!-- Please keep an empty line above the dashes. -->
---
This PR updates the documentation in howto/customize-ui.rst to reflect the correct import path and usage of the UIAlert class for Airflow v3.
Previously, the documentation showed:
```
from airflow.www.utils import UIAlert
DASHBOARD_UIALERTS = [
UIAlert("Welcome to Airflow"),
]
```
In Airflow v3, UIAlert has moved to the airflow.api_fastapi.common.types module and requires keyword arguments text and category.
The updated example is:
```
from airflow.api_fastapi.common.types import UIAlert
DASHBOARD_UIALERTS = [
UIAlert(text="Welcome to Airflow", category="info"),
]
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Docs: update UIAlert import path and usage for v3 (#58089) [airflow]
Posted by "pierrejeambrun (via GitHub)" <gi...@apache.org>.
pierrejeambrun commented on PR #58090:
URL: https://github.com/apache/airflow/pull/58090#issuecomment-3557460147
Yes please, modify the `customize-ui.rst` file so that it does not reference this missing classe and point to the appropriate one.
There is also one occurence of such import in `chart/values.yaml` but we shouldn't modify it. (it's airflow 2 code)
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Docs: update UIAlert import path and usage for v3 (#58089) [airflow]
Posted by "Lohith625 (via GitHub)" <gi...@apache.org>.
Lohith625 commented on PR #58090:
URL: https://github.com/apache/airflow/pull/58090#issuecomment-3579219306
> I think we are missing line 124 too, otherwise looking good to me.
Thanks for pointing that out. I’ve now updated the line at 124 as well.
Please let me know if any other adjustments are needed.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Docs: update UIAlert import path and usage for v3 (#58089) [airflow]
Posted by "github-actions[bot] (via GitHub)" <gi...@apache.org>.
github-actions[bot] commented on PR #58090:
URL: https://github.com/apache/airflow/pull/58090#issuecomment-3595914420
### Backport successfully created: v3-1-test
<table>
<tr>
<th>Status</th>
<th>Branch</th>
<th>Result</th>
</tr>
<tr>
<td>✅</td>
<td>v3-1-test</td>
<td><a href="https://github.com/apache/airflow/pull/58891"><img src="https://img.shields.io/badge/PR-58891-blue" alt="PR Link"></a></td>
</tr>
</table>
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Docs: update UIAlert import path and usage for v3 (#58089) [airflow]
Posted by "pierrejeambrun (via GitHub)" <gi...@apache.org>.
pierrejeambrun merged PR #58090:
URL: https://github.com/apache/airflow/pull/58090
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Docs: update UIAlert import path and usage for v3 (#58089) [airflow]
Posted by "Lohith625 (via GitHub)" <gi...@apache.org>.
Lohith625 commented on PR #58090:
URL: https://github.com/apache/airflow/pull/58090#issuecomment-3507443198
Hi @lp-jump 👋
I’ve updated the UIAlert example in howto/customize-ui.rst as suggested.
While reviewing the docs, I also noticed a few other occurrences of airflow.www.utils in different sections.
Would you like me to update those as well to align with the v3 structure, or should we keep this PR limited to just the UIAlert example?
Happy to make the additional changes if needed. 😊
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Docs: update UIAlert import path and usage for v3 (#58089) [airflow]
Posted by "Lohith625 (via GitHub)" <gi...@apache.org>.
Lohith625 commented on PR #58090:
URL: https://github.com/apache/airflow/pull/58090#issuecomment-3575765474
Hi @pierrejeambrun 👋
I have updated all occurrences of airflow.www.utils and deprecated UIAlert usage inside customize-ui.rst, as requested.
I did not modify the import inside chart/values.yaml because it is Airflow 2 code, following your note.
Please let me know if any further updates are needed. 😊
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org