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

Restructuring PR classification for providers with misc changes #40646

Merged
merged 2 commits into from
Jul 8, 2024

Conversation

amoghrajesh
Copy link
Contributor

There is a gap in the prepare-provider-documentation command that doesn't allow categorising the misc kind of changes properly and a hack needs to be used.

This PR corrects that fault and lets you also bifurcate PRs into misc category as well.

Example:

NEXT VERSION AFTER + 8.25.0
...........................

Latest change: 2024-07-06

=================================================================================================  ===========  =================================================================================
Commit                                                                                             Committed    Subject
=================================================================================================  ===========  =================================================================================
`c72920af3b <https://github.com/apache/airflow/commit/c72920af3be5f0590c832d23633acbf4765e9eb3>`_  2024-07-06   ``Do not dynamically determine op links for emr serverless (#40627)``
`b7d0bf9800 <https://github.com/apache/airflow/commit/b7d0bf9800974e2029a777e20417e3498e665503>`_  2024-07-04   ``fix OpenLineage extraction for AthenaOperator (#40545)``
`8e04ef088f <https://github.com/apache/airflow/commit/8e04ef088fd2c817800f53b69bff1ac0680ac8b5>`_  2024-07-02   ``Be able to remove ACL in S3 hook's copy_object (#40518)``
`015ac89689 <https://github.com/apache/airflow/commit/015ac89689cb278d78ed4d65825254b67d476db8>`_  2024-07-02   ``Use base aws classes in AWS Glue Data Catalog Sensors (#40492)``
`b8aab5cf63 <https://github.com/apache/airflow/commit/b8aab5cf6332681b797e2aaea67c10e6ddf6bb46>`_  2024-07-02   ``Use base aws classes in AWS Glue Crawlers Operators/Sensors/Triggers (#40504)``
`5ec81b6f95 <https://github.com/apache/airflow/commit/5ec81b6f9536bd4824ff39574ec9602916d06af8>`_  2024-06-28   ``Fix docs build re aws changelog (#40488)``
`8d5dbaae37 <https://github.com/apache/airflow/commit/8d5dbaae37c2bcd0be360fdf8d42c5f72c7629da>`_  2024-06-28   ``Remove todo re bucket_name decorator in s3 hook (#40485)``
`bbfeee4aee <https://github.com/apache/airflow/commit/bbfeee4aee7203e934d50bc455f10d4d6a26f84a>`_  2024-06-28   ``Reduce memory footprint of s3 key trigger (#40473)``
`6c12744dd8 <https://github.com/apache/airflow/commit/6c12744dd8656e1d8b066c7edc8f0ab60ac124d2>`_  2024-06-28   ``Adding cluster to ecs trigger event to avoid defer error (#40482)``
`a62bd83188 <https://github.com/apache/airflow/commit/a62bd831885957c55b073bf309bc59a1d505e8fb>`_  2024-06-27   ``Enable enforcing pydocstyle rule D213 in ruff. (#40448)``
=================================================================================================  ===========  =================================================================================

Does the provider: amazon have any changes apart from 'doc-only'?
Press y/N/q: y

Define the type of change for `Do not dynamically determine op links for emr serverless (https://github.com/apache/airflow/pull/40627)` by referring to the above table
Type of change (b)ugfix, (f)eature, (x)breaking change, (m)misc, (s)kip, (q)uit ? x


Define the type of change for `fix OpenLineage extraction for AthenaOperator (https://github.com/apache/airflow/pull/40545)` by referring to the above table
Type of change (b)ugfix, (f)eature, (x)breaking change, (m)misc, (s)kip, (q)uit ? x


Define the type of change for `Be able to remove ACL in S3 hook's copy_object (https://github.com/apache/airflow/pull/40518)` by referring to the above table
Type of change (b)ugfix, (f)eature, (x)breaking change, (m)misc, (s)kip, (q)uit ? b


Define the type of change for `Use base aws classes in AWS Glue Data Catalog Sensors (https://github.com/apache/airflow/pull/40492)` by referring to the above table
Type of change (b)ugfix, (f)eature, (x)breaking change, (m)misc, (s)kip, (q)uit ? f


Define the type of change for `Use base aws classes in AWS Glue Crawlers Operators/Sensors/Triggers (https://github.com/apache/airflow/pull/40504)` by referring to the above table
Type of change (b)ugfix, (f)eature, (x)breaking change, (m)misc, (s)kip, (q)uit ? m


Define the type of change for `Fix docs build re aws changelog (https://github.com/apache/airflow/pull/40488)` by referring to the above table
Type of change (b)ugfix, (f)eature, (x)breaking change, (m)misc, (s)kip, (q)uit ? m


Define the type of change for `Remove todo re bucket_name decorator in s3 hook (https://github.com/apache/airflow/pull/40485)` by referring to the above table
Type of change (b)ugfix, (f)eature, (x)breaking change, (m)misc, (s)kip, (q)uit ? s


Define the type of change for `Reduce memory footprint of s3 key trigger (https://github.com/apache/airflow/pull/40473)` by referring to the above table
Type of change (b)ugfix, (f)eature, (x)breaking change, (m)misc, (s)kip, (q)uit ? m


Define the type of change for `Adding cluster to ecs trigger event to avoid defer error (https://github.com/apache/airflow/pull/40482)` by referring to the above table
Type of change (b)ugfix, (f)eature, (x)breaking change, (m)misc, (s)kip, (q)uit ? f


Define the type of change for `Enable enforcing pydocstyle rule D213 in ruff. (https://github.com/apache/airflow/pull/40448)` by referring to the above table
Type of change (b)ugfix, (f)eature, (x)breaking change, (m)misc, (s)kip, (q)uit ? f

The version will be bumped because of TypeOfChange.BREAKING_CHANGE kind of change
Provider amazon has been classified as:

Breaking changes - bump in MAJOR version needed

Bumped version to 9.0.0

Updated source-date-epoch to 1720429304

New version of the 'amazon' package is ready to be released!


Do you want to leave the version for amazon with version: 9.0.0 as is?
Press y/N/q: y
 Proceeding with provider: amazon version as 9.0.0
Checking for backticks correctly generated in: /Users/adesai/Documents/OSS/airflow/docs/apache-airflow-providers-amazon/changelog.rst
Generated /Users/adesai/Documents/OSS/airflow/docs/apache-airflow-providers-amazon/changelog.rst for amazon is OK

Generated /Users/adesai/Documents/OSS/airflow/docs/apache-airflow-providers-amazon/commits.rst file for the amazon provider

37a38,57
> 9.0.0
> .....
>
> Latest change: 2024-07-06
>
> =================================================================================================  ===========  =================================================================================
> Commit                                                                                             Committed    Subject
> =================================================================================================  ===========  =================================================================================
> `c72920af3b <https://github.com/apache/airflow/commit/c72920af3be5f0590c832d23633acbf4765e9eb3>`_  2024-07-06   ``Do not dynamically determine op links for emr serverless (#40627)``
> `b7d0bf9800 <https://github.com/apache/airflow/commit/b7d0bf9800974e2029a777e20417e3498e665503>`_  2024-07-04   ``fix OpenLineage extraction for AthenaOperator (#40545)``
> `8e04ef088f <https://github.com/apache/airflow/commit/8e04ef088fd2c817800f53b69bff1ac0680ac8b5>`_  2024-07-02   ``Be able to remove ACL in S3 hook's copy_object (#40518)``
> `015ac89689 <https://github.com/apache/airflow/commit/015ac89689cb278d78ed4d65825254b67d476db8>`_  2024-07-02   ``Use base aws classes in AWS Glue Data Catalog Sensors (#40492)``
> `b8aab5cf63 <https://github.com/apache/airflow/commit/b8aab5cf6332681b797e2aaea67c10e6ddf6bb46>`_  2024-07-02   ``Use base aws classes in AWS Glue Crawlers Operators/Sensors/Triggers (#40504)``
> `5ec81b6f95 <https://github.com/apache/airflow/commit/5ec81b6f9536bd4824ff39574ec9602916d06af8>`_  2024-06-28   ``Fix docs build re aws changelog (#40488)``
> `8d5dbaae37 <https://github.com/apache/airflow/commit/8d5dbaae37c2bcd0be360fdf8d42c5f72c7629da>`_  2024-06-28   ``Remove todo re bucket_name decorator in s3 hook (#40485)``
> `bbfeee4aee <https://github.com/apache/airflow/commit/bbfeee4aee7203e934d50bc455f10d4d6a26f84a>`_  2024-06-28   ``Reduce memory footprint of s3 key trigger (#40473)``
> `6c12744dd8 <https://github.com/apache/airflow/commit/6c12744dd8656e1d8b066c7edc8f0ab60ac124d2>`_  2024-06-28   ``Adding cluster to ecs trigger event to avoid defer error (#40482)``
> `a62bd83188 <https://github.com/apache/airflow/commit/a62bd831885957c55b073bf309bc59a1d505e8fb>`_  2024-06-27   ``Enable enforcing pydocstyle rule D213 in ruff. (#40448)``
> =================================================================================================  ===========  =================================================================================
>
41c61
< Latest change: 2024-06-19
---
> Latest change: 2024-06-22
45a66
> `6e5ae26382 <https://github.com/apache/airflow/commit/6e5ae26382b328e88907e8301d4b2352ef8524c5>`_  2024-06-22   ``Prepare docs 2nd wave June 2024 (#40273)``
Checking for backticks correctly generated in: /Users/adesai/Documents/OSS/airflow/docs/apache-airflow-providers-amazon/commits.rst
Generated /Users/adesai/Documents/OSS/airflow/docs/apache-airflow-providers-amazon/commits.rst for amazon is OK

Updates changelog for last release of package 'amazon'

New version of the 'amazon' package is ready to be released!

***

---

***************

*** 23,32 ****

--- 23,64 ----


  ``apache-airflow-providers-amazon``

  Changelog
  ---------
+
+ 9.0.0
+ .....
+
+ Breaking changes
+ ~~~~~~~~~~~~~~~~
+
+ * ``Do not dynamically determine op links for emr serverless (#40627)``
+ * ``fix OpenLineage extraction for AthenaOperator (#40545)``
+
+ Features
+ ~~~~~~~~
+
+ * ``Use base aws classes in AWS Glue Data Catalog Sensors (#40492)``
+ * ``Adding cluster to ecs trigger event to avoid defer error (#40482)``
+ * ``Enable enforcing pydocstyle rule D213 in ruff. (#40448)``
+
+ Bug Fixes
+ ~~~~~~~~~
+
+ * ``Be able to remove ACL in S3 hook's copy_object (#40518)``
+
+ Misc
+ ~~~~
+
+ * ``Use base aws classes in AWS Glue Crawlers Operators/Sensors/Triggers (#40504)``
+ * ``Fix docs build re aws changelog (#40488)``
+ * ``Reduce memory footprint of s3 key trigger (#40473)``
+
+ .. Below changes are excluded from the changelog. Move them to
+    appropriate section above if needed. Do not delete the lines(!):
+    * ``Remove todo re bucket_name decorator in s3 hook (#40485)``

  main
  ....

  Bug Fixes
The provider amazon changelog for `9.0.0` version is missing. Generating fresh changelog.

Update index.rst for amazon


Generated /Users/adesai/Documents/OSS/airflow/docs/apache-airflow-providers-amazon/index.rst file for the amazon provider

89c89
< Release: 8.25.0
---
> Release: 9.0.0
164,165c164,165
< * `The apache-airflow-providers-amazon 8.25.0 sdist package <https://downloads.apache.org/airflow/providers/apache_airflow_providers_amazon-8.25.0.tar.gz>`_ (`asc <https://downloads.apache.org/airflow/providers/apache_airflow_providers_amazon-8.25.0.tar.gz.asc>`__, `sha512 <https://downloads.apache.org/airflow/providers/apache_airflow_providers_amazon-8.25.0.tar.gz.sha512>`__)
< * `The apache-airflow-providers-amazon 8.25.0 wheel package <https://downloads.apache.org/airflow/providers/apache_airflow_providers_amazon-8.25.0-py3-none-any.whl>`_ (`asc <https://downloads.apache.org/airflow/providers/apache_airflow_providers_amazon-8.25.0-py3-none-any.whl.asc>`__, `sha512 <https://downloads.apache.org/airflow/providers/apache_airflow_providers_amazon-8.25.0-py3-none-any.whl.sha512>`__)
---
> * `The apache-airflow-providers-amazon 9.0.0 sdist package <https://downloads.apache.org/airflow/providers/apache_airflow_providers_amazon-9.0.0.tar.gz>`_ (`asc <https://downloads.apache.org/airflow/providers/apache_airflow_providers_amazon-9.0.0.tar.gz.asc>`__, `sha512 <https://downloads.apache.org/airflow/providers/apache_airflow_providers_amazon-9.0.0.tar.gz.sha512>`__)
> * `The apache-airflow-providers-amazon 9.0.0 wheel package <https://downloads.apache.org/airflow/providers/apache_airflow_providers_amazon-9.0.0-py3-none-any.whl>`_ (`asc <https://downloads.apache.org/airflow/providers/apache_airflow_providers_amazon-9.0.0-py3-none-any.whl.asc>`__, `sha512 <https://downloads.apache.org/airflow/providers/apache_airflow_providers_amazon-9.0.0-py3-none-any.whl.sha512>`__)


Summary of prepared documentation:

Success: 1

amazon


Successfully prepared documentation for packages!



Please review the updated files, classify the changelog entries and commit the changes.
image

^ 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.

@amoghrajesh
Copy link
Contributor Author

@eladkal this will help you out :)

@amoghrajesh amoghrajesh requested a review from eladkal July 8, 2024 09:15
Copy link
Contributor

@eladkal eladkal left a comment

Choose a reason for hiding this comment

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

Cool!

@potiuk potiuk merged commit 19576f3 into apache:main Jul 8, 2024
80 checks passed
romsharon98 pushed a commit to romsharon98/airflow that referenced this pull request Jul 26, 2024
…he#40646)

* Restructuring PR classification for providers with misc changes

* updating the UT
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants