You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@airflow.apache.org by "gopidesupavan (via GitHub)" <gi...@apache.org> on 2025/05/08 17:32:16 UTC
[PR] Update s3 docs publishing workflow description and remove selective check [airflow]
gopidesupavan opened a new pull request, #50365:
URL: https://github.com/apache/airflow/pull/50365
<img width="462" alt="image" src="https://github.com/user-attachments/assets/59bf0d80-0fa3-428e-bf21-52574326b0a7" />
<!--
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. -->
---
**^ 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: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Update s3 docs publishing workflow description and remove selective check [airflow]
Posted by "gopidesupavan (via GitHub)" <gi...@apache.org>.
gopidesupavan commented on PR #50365:
URL: https://github.com/apache/airflow/pull/50365#issuecomment-2863789435
@potiuk do we really need selective check here? as we are checking out tag.
--
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] Update s3 docs publishing workflow description and remove selective check [airflow]
Posted by "potiuk (via GitHub)" <gi...@apache.org>.
potiuk merged PR #50365:
URL: https://github.com/apache/airflow/pull/50365
--
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] Update s3 docs publishing workflow description and remove selective check [airflow]
Posted by "gopidesupavan (via GitHub)" <gi...@apache.org>.
gopidesupavan commented on PR #50365:
URL: https://github.com/apache/airflow/pull/50365#issuecomment-2863791710
@eladkal does the description make sense, you want me add more ? or any other please comment i will apply them
--
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] Update s3 docs publishing workflow description and remove selective check [airflow]
Posted by "potiuk (via GitHub)" <gi...@apache.org>.
potiuk commented on PR #50365:
URL: https://github.com/apache/airflow/pull/50365#issuecomment-2863840381
> Make sense?
Makes sense for me
Maybe a good thing would be to have "All" placeholder for Include - similarly as the "NO_DOCS" one? also the NO_DOCS is a bit misleading - maybe "No exclusions" will be better or something.
Also maybe ordering might be improved:
* Branch
* Includes ("All")
* Excludes( "None")
* Destination location
One other thing- > Destination location could be a choice rather than free-entry form - we have literally two buckets we can push to
--
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] Update s3 docs publishing workflow description and remove selective check [airflow]
Posted by "gopidesupavan (via GitHub)" <gi...@apache.org>.
gopidesupavan commented on code in PR #50365:
URL: https://github.com/apache/airflow/pull/50365#discussion_r2080368867
##########
.github/workflows/publish-docs-to-s3.yml:
##########
@@ -24,21 +24,28 @@ on: # yamllint disable-line rule:truthy
description: "The branch or tag to checkout for the docs publishing"
required: true
type: string
+ include-docs:
+ description: |
+ Space separated list of docs to build.
+ To publish docs for nested provider packages, provide the package name with `.`
+ eg: amazon common.messaging apache.kafka
+
+ required: false
+ default: "all"
+ type: string
exclude-docs:
description: "Comma separated list of docs to exclude"
required: false
- default: "NO_DOCS"
+ default: "no-docs-excluded"
type: string
destination-location:
description: "The destination location in S3"
required: false
default: "s3://staging-docs-airflow-apache-org/docs"
- type: string
- docs-list-as-string:
- description: "Space separated list of docs to build"
- required: false
- default: ""
- type: string
+ type: choice
+ options:
+ - s3://staging-docs-airflow-apache-org/docs
Review Comment:
Once i configured CloudFront for live site, i will add live s3 bucket here.
--
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] Update s3 docs publishing workflow description and remove selective check [airflow]
Posted by "gopidesupavan (via GitHub)" <gi...@apache.org>.
gopidesupavan commented on PR #50365:
URL: https://github.com/apache/airflow/pull/50365#issuecomment-2863819417
> I think what confuses me is the include vs exclude. I assume only one of them can be set?
Using include is generally preferable.
However, exclude_docs is useful when all providers are being built by default without no include input, and you want to exclude specific provider docs. In that case, you can provide an exclude input and simply.
Make sense?
--
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] Update s3 docs publishing workflow description and remove selective check [airflow]
Posted by "eladkal (via GitHub)" <gi...@apache.org>.
eladkal commented on PR #50365:
URL: https://github.com/apache/airflow/pull/50365#issuecomment-2863801324
I think what confuses me is the include vs exclude.
I assume only one of them can be set?
--
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] Update s3 docs publishing workflow description and remove selective check [airflow]
Posted by "gopidesupavan (via GitHub)" <gi...@apache.org>.
gopidesupavan commented on PR #50365:
URL: https://github.com/apache/airflow/pull/50365#issuecomment-2864105274
> > Make sense?
>
> Makes sense for me
>
> Maybe a good thing would be to have "All" placeholder for Include - similarly as the "NO_DOCS" one? also the NO_DOCS is a bit misleading - maybe "No exclusions" will be better or something.
>
> Also maybe ordering might be improved:
>
> * Branch
> * Includes ("All")
> * Excludes( "None")
> * Destination location
>
> One other thing- > Destination location could be a choice rather than free-entry form - we have literally two buckets we can push to
Yeah that make sense updated :) now.
--
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