HsiuChuanHsu opened a new pull request, #55677:
URL: https://github.com/apache/airflow/pull/55677
<!--
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. -->
### **Description**
This PR fixes documentation links in the Helm Chart Release Candidate (RC)
versions to properly point to the staged documentation
(https://airflow.staged.apache.org) instead of the stable documentation
(https://airlfow.apache.org/).
Based on the guidance from @potiuk:
> How it should be done - the links should be still "prod" - but they should
be dynamically replaced with the staged build when .RC version of the chart is
being prepared as release - so it should be part of the "breeze
release-management" commands and code that is run to prepare the release, not
committed to the repo.
Ref:
https://github.com/apache/airflow/pull/54493#pullrequestreview-3124908204
### **Changes introduced**
Two functions in `release-management` have been updated to replace the URLs
dynamically when Helm Chart RC versions are released:
1. `prepare-helm-chart-tarball`
2. `prepare-helm-chart-package`
With this change:
- Production builds will continue pointing to production documentation links.
- RC builds will automatically use staging documentation links during the
release preparation process.
Closes: #50569
---
**^ Add meaningful description above**
Read the **[Pull Request
Guidelines](https://github.com/apache/airflow/blob/main/contributing-docs/05_pull_requests.rst#pull-request-guidelines)**
for more information.
In case of fundamental code changes, an Airflow Improvement Proposal
([AIP](https://cwiki.apache.org/confluence/display/AIRFLOW/Airflow+Improvement+Proposals))
is needed.
In case of a new dependency, check compliance with the [ASF 3rd Party
License Policy](https://www.apache.org/legal/resolved.html#category-x).
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
[airflow-core/newsfragments](https://github.com/apache/airflow/tree/main/airflow-core/newsfragments).
--
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: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
