You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@airflow.apache.org by "potiuk (via GitHub)" <gi...@apache.org> on 2023/12/28 10:37:26 UTC
[PR] Improve generation of "Status of testing" issue [airflow]
potiuk opened a new pull request, #36470:
URL: https://github.com/apache/airflow/pull/36470
This PR improves/simplifies the process of issue generation when provider package rc candidates are prepared for voting.
It improves the commmand to generate the issue and makes it simpler (less copy&paste) to create such issue, the issue also does not use the "Meta" template and gets the right labels assigned automatically.
Recent changes that automatically derive the suffix from PyPI packages prepared, removed the need of passing `--suffix` as parameter. In all cases the right rc* suffix will be automatically added during issue generation based on the version of package being prepared. The process has been updated and command simplified by removing the `--suffix` flag.
When the issue is prepared, we display the issue in terminal and asked the release manager to create the issue by copy&pasting the issue content and title to a new issue, but that required a few copy&pastes and opening new Issue via "Meta" task type. This PR simplifies it a bit by not only displaying the content but also generating a URL that can be either copy&pasted to browser URL field or just Cmd+clicked if your terminal allows that. Issue created this way does not have the "Body" field header and has the labels properly assigned including a dedicated "testing status" label that is used to gether stats for past "status" issues.
The advice for release manager has been improved (the comment generated had some missing end of sentence and it should be now clearer on how to iterate during issue generation if you want to remove some PRs from the generated issue content.
<!--
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.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 [newsfragments](https://github.com/apache/airflow/tree/main/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] Improve generation of "Status of testing" issue [airflow]
Posted by "potiuk (via GitHub)" <gi...@apache.org>.
potiuk commented on code in PR #36470:
URL: https://github.com/apache/airflow/pull/36470#discussion_r1437730566
##########
dev/README_RELEASE_PROVIDER_PACKAGES.md:
##########
@@ -531,26 +531,38 @@ git push --set-upstream origin "${branch}"
Create a GitHub issue with the content generated via manual
execution of the script below. You will use link to that issue in the next step. You need a GITHUB_TOKEN
-set as your environment variable.
-
-You can also pass the token as `--github-token` option in the script.
-You can also pass list of PR to be excluded from the issue with `--excluded-pr-list`.
+set as your environment variable or pass the token as `--github-token` option in the script.
```shell script
cd "${AIRFLOW_REPO_ROOT}"
-breeze release-management generate-issue-content-providers --only-available-in-dist
+breeze release-management generate-issue-content-providers --only-available-in-dist --github-token TOKEN
```
-You can also generate the token by following
-[this link](https://github.com/settings/tokens/new?description=Read%20sssues&scopes=repo:status)
+You can generate the token by following
+[this link](https://github.com/settings/tokens/new?description=Read%20issues&scopes=repo:status)
+
+If you see in the output that some of the PRs are just "noise" (i.e. there is no need to verify them
+as they are misc/documentation kind of changes that have no impact on the actual installation of
+the provider or the code of the provider, can optionally pass list of PR to be excluded from
+the issue with `--excluded-pr-list`. This might limit the scope of verification (some providers
+might disappear from the list and list of authors that will be pinged in the generated issue.
Review Comment:
resolved. Removed the braces altogether.
--
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] Improve generation of "Status of testing" issue [airflow]
Posted by "eladkal (via GitHub)" <gi...@apache.org>.
eladkal commented on PR #36470:
URL: https://github.com/apache/airflow/pull/36470#issuecomment-1871117424
BTW we seems to have some differences between issue generation of providers and of core. In core it also generates the issue with link to the PR (calling for testing to both issue author and PR author) while in providers it brings only PRs.
I wanted to fix it but didn't find time yet
--
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] Improve generation of "Status of testing" issue [airflow]
Posted by "potiuk (via GitHub)" <gi...@apache.org>.
potiuk merged PR #36470:
URL: https://github.com/apache/airflow/pull/36470
--
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] Improve generation of "Status of testing" issue [airflow]
Posted by "potiuk (via GitHub)" <gi...@apache.org>.
potiuk commented on code in PR #36470:
URL: https://github.com/apache/airflow/pull/36470#discussion_r1437678832
##########
dev/README_RELEASE_PROVIDER_PACKAGES.md:
##########
@@ -531,26 +531,38 @@ git push --set-upstream origin "${branch}"
Create a GitHub issue with the content generated via manual
execution of the script below. You will use link to that issue in the next step. You need a GITHUB_TOKEN
-set as your environment variable.
-
-You can also pass the token as `--github-token` option in the script.
-You can also pass list of PR to be excluded from the issue with `--excluded-pr-list`.
+set as your environment variable or pass the token as `--github-token` option in the script.
Review Comment:
> super nit: Will it be better if we provide the export GITHUB_TOKEN=<your token> here?
Both work. I personally use a token that I generate only for that and delete right after, so I prefer to use `--github-token` as it's single command to pass it in. But we can add example for both.
--
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] Improve generation of "Status of testing" issue [airflow]
Posted by "potiuk (via GitHub)" <gi...@apache.org>.
potiuk commented on code in PR #36470:
URL: https://github.com/apache/airflow/pull/36470#discussion_r1437730829
##########
dev/README_RELEASE_PROVIDER_PACKAGES.md:
##########
@@ -531,26 +531,38 @@ git push --set-upstream origin "${branch}"
Create a GitHub issue with the content generated via manual
execution of the script below. You will use link to that issue in the next step. You need a GITHUB_TOKEN
-set as your environment variable.
-
-You can also pass the token as `--github-token` option in the script.
-You can also pass list of PR to be excluded from the issue with `--excluded-pr-list`.
+set as your environment variable or pass the token as `--github-token` option in the script.
```shell script
cd "${AIRFLOW_REPO_ROOT}"
-breeze release-management generate-issue-content-providers --only-available-in-dist
+breeze release-management generate-issue-content-providers --only-available-in-dist --github-token TOKEN
```
-You can also generate the token by following
-[this link](https://github.com/settings/tokens/new?description=Read%20sssues&scopes=repo:status)
+You can generate the token by following
+[this link](https://github.com/settings/tokens/new?description=Read%20issues&scopes=repo:status)
+
+If you see in the output that some of the PRs are just "noise" (i.e. there is no need to verify them
+as they are misc/documentation kind of changes that have no impact on the actual installation of
+the provider or the code of the provider, can optionally pass list of PR to be excluded from
+the issue with `--excluded-pr-list`. This might limit the scope of verification (some providers
+might disappear from the list and list of authors that will be pinged in the generated issue.
-If you are preparing release for RC2/RC3 candidates, you should add `--suffix` parameter:
+You can repeat that and regenerate the issue content until you are happy with the generated issue.
```shell script
-breeze release-management generate-issue-content-providers --only-available-in-dist --suffix rc2
+cd "${AIRFLOW_REPO_ROOT}"
+
+breeze release-management generate-issue-content-providers --only-available-in-dist --github-token TOKEN \
+ --excluded-pr-list PR_NUMBER1,PR_NUMBER2
```
+It's also OK to manually modify the content of such generated issue before actually creating the
+issue (there is a comment generated with NOTE TO RELEASE MANAGER about this in the issue content.
Review Comment:
Removed the brace as well.
--
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] Improve generation of "Status of testing" issue [airflow]
Posted by "potiuk (via GitHub)" <gi...@apache.org>.
potiuk commented on code in PR #36470:
URL: https://github.com/apache/airflow/pull/36470#discussion_r1437682456
##########
dev/README_RELEASE_PROVIDER_PACKAGES.md:
##########
@@ -531,26 +531,38 @@ git push --set-upstream origin "${branch}"
Create a GitHub issue with the content generated via manual
execution of the script below. You will use link to that issue in the next step. You need a GITHUB_TOKEN
-set as your environment variable.
-
-You can also pass the token as `--github-token` option in the script.
-You can also pass list of PR to be excluded from the issue with `--excluded-pr-list`.
+set as your environment variable or pass the token as `--github-token` option in the script.
Review Comment:
> most of times you don't need a token as the list is very small. for 80+ PRs in list it requires token
My experience was that the rate limit hits me when It is about 95% done :D. But yeah we can mention that you might not needed. Also you need to remember that it very much depends where you are physically and how you are connected to the network. Github's (and any other) rate limiting on unauthenticated requests is based on the public IP address that you are connecting from. If you are behind a NAT where there are many other users using anonymous Github issue API calls, you share the rate limit with them - so for some users, the rate limit might start happening pretty much instanteneously - maybe you have your own public IP address at home and then you are fine, but if you are ina corporate network, then more often than not you might share your public IP address with 100s or even multiple thousands of people. Using GITHUB_TOKEN is the only way to guarantee that a) your rate limit is way higher b) you actually have your own private rate limit.
So I personally ALWAYS use github token - and usually I just generate it for the time of running the command and discard right after - those are pretty much easily craated and I treat them as "one-time-use" only
--
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] Improve generation of "Status of testing" issue [airflow]
Posted by "eladkal (via GitHub)" <gi...@apache.org>.
eladkal commented on code in PR #36470:
URL: https://github.com/apache/airflow/pull/36470#discussion_r1437653089
##########
dev/README_RELEASE_PROVIDER_PACKAGES.md:
##########
@@ -531,26 +531,38 @@ git push --set-upstream origin "${branch}"
Create a GitHub issue with the content generated via manual
execution of the script below. You will use link to that issue in the next step. You need a GITHUB_TOKEN
-set as your environment variable.
-
-You can also pass the token as `--github-token` option in the script.
-You can also pass list of PR to be excluded from the issue with `--excluded-pr-list`.
+set as your environment variable or pass the token as `--github-token` option in the script.
Review Comment:
most of times you don't need a token as the list is very small. for 80+ PRs in list it requires token
--
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] Improve generation of "Status of testing" issue [airflow]
Posted by "potiuk (via GitHub)" <gi...@apache.org>.
potiuk commented on PR #36470:
URL: https://github.com/apache/airflow/pull/36470#issuecomment-1871192408
> BTW we seems to have some differences between issue generation of providers and of core. In core it also generates the issue with link to the PR (calling for testing to both issue author and PR author) while in providers it brings only PRs.
I wanted to fix it but didn't find time yet
Yep. I planned to "commonalize" the two as well as one of the next steps. Let's see who will be first :)
--
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] Improve generation of "Status of testing" issue [airflow]
Posted by "amoghrajesh (via GitHub)" <gi...@apache.org>.
amoghrajesh commented on code in PR #36470:
URL: https://github.com/apache/airflow/pull/36470#discussion_r1437615651
##########
dev/README_RELEASE_PROVIDER_PACKAGES.md:
##########
@@ -531,26 +531,38 @@ git push --set-upstream origin "${branch}"
Create a GitHub issue with the content generated via manual
execution of the script below. You will use link to that issue in the next step. You need a GITHUB_TOKEN
-set as your environment variable.
-
-You can also pass the token as `--github-token` option in the script.
-You can also pass list of PR to be excluded from the issue with `--excluded-pr-list`.
+set as your environment variable or pass the token as `--github-token` option in the script.
```shell script
cd "${AIRFLOW_REPO_ROOT}"
-breeze release-management generate-issue-content-providers --only-available-in-dist
+breeze release-management generate-issue-content-providers --only-available-in-dist --github-token TOKEN
```
-You can also generate the token by following
-[this link](https://github.com/settings/tokens/new?description=Read%20sssues&scopes=repo:status)
+You can generate the token by following
+[this link](https://github.com/settings/tokens/new?description=Read%20issues&scopes=repo:status)
+
+If you see in the output that some of the PRs are just "noise" (i.e. there is no need to verify them
+as they are misc/documentation kind of changes that have no impact on the actual installation of
+the provider or the code of the provider, can optionally pass list of PR to be excluded from
+the issue with `--excluded-pr-list`. This might limit the scope of verification (some providers
+might disappear from the list and list of authors that will be pinged in the generated issue.
Review Comment:
nit: Missing closing braces
```
If you see in the output that some of the PRs are just "noise" (i.e. there is no need to verify them
as they are misc/documentation kind of changes that have no impact on the actual installation of
the provider or the code of the provider, you can optionally pass a list of PRs to be excluded from
the issue with `--excluded-pr-list`). This might limit the scope of verification (some providers
might disappear from the list and the list of authors that will be pinged in the generated issue).
```
##########
dev/README_RELEASE_PROVIDER_PACKAGES.md:
##########
@@ -531,26 +531,38 @@ git push --set-upstream origin "${branch}"
Create a GitHub issue with the content generated via manual
execution of the script below. You will use link to that issue in the next step. You need a GITHUB_TOKEN
-set as your environment variable.
-
-You can also pass the token as `--github-token` option in the script.
-You can also pass list of PR to be excluded from the issue with `--excluded-pr-list`.
+set as your environment variable or pass the token as `--github-token` option in the script.
Review Comment:
super nit: Will it be better if we provide the `export GITHUB_TOKEN=<your token>` here?
##########
dev/README_RELEASE_PROVIDER_PACKAGES.md:
##########
@@ -531,26 +531,38 @@ git push --set-upstream origin "${branch}"
Create a GitHub issue with the content generated via manual
execution of the script below. You will use link to that issue in the next step. You need a GITHUB_TOKEN
-set as your environment variable.
-
-You can also pass the token as `--github-token` option in the script.
-You can also pass list of PR to be excluded from the issue with `--excluded-pr-list`.
+set as your environment variable or pass the token as `--github-token` option in the script.
```shell script
cd "${AIRFLOW_REPO_ROOT}"
-breeze release-management generate-issue-content-providers --only-available-in-dist
+breeze release-management generate-issue-content-providers --only-available-in-dist --github-token TOKEN
```
-You can also generate the token by following
-[this link](https://github.com/settings/tokens/new?description=Read%20sssues&scopes=repo:status)
+You can generate the token by following
+[this link](https://github.com/settings/tokens/new?description=Read%20issues&scopes=repo:status)
+
+If you see in the output that some of the PRs are just "noise" (i.e. there is no need to verify them
+as they are misc/documentation kind of changes that have no impact on the actual installation of
+the provider or the code of the provider, can optionally pass list of PR to be excluded from
+the issue with `--excluded-pr-list`. This might limit the scope of verification (some providers
+might disappear from the list and list of authors that will be pinged in the generated issue.
-If you are preparing release for RC2/RC3 candidates, you should add `--suffix` parameter:
+You can repeat that and regenerate the issue content until you are happy with the generated issue.
```shell script
-breeze release-management generate-issue-content-providers --only-available-in-dist --suffix rc2
+cd "${AIRFLOW_REPO_ROOT}"
+
+breeze release-management generate-issue-content-providers --only-available-in-dist --github-token TOKEN \
+ --excluded-pr-list PR_NUMBER1,PR_NUMBER2
```
+It's also OK to manually modify the content of such generated issue before actually creating the
+issue (there is a comment generated with NOTE TO RELEASE MANAGER about this in the issue content.
Review Comment:
nit: missing closing braces
--
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