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

More documentation update for June providers release #16405

Conversation

potiuk
Copy link
Member

@potiuk potiuk commented Jun 11, 2021

The provider changelogs were already merged but they could not be
released due to unavailability of signing key in remote location
The documentation has once more been updated, including latest
merges - documentation-only changes were removed from
bugs/feetures/breaking changes lists.

Few other improvements:

  • Pre-commit was added to make sure that the documentation
    in provider's index.rst files includes the latest changelog.
  • Index.rst now contain includes of the CHANGELOG.rst rather
    than copy of the CHANGELOG.rst
  • The prepare-provider-package breeze command has --non-interactive
    flag now
  • generated provider package README.rst contain changelog so you can
    see the changelog directly in PyPI

^ Add meaningful description above

Read the Pull Request Guidelines for more information.
In case of fundamental code change, 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 UPDATING.md.

@boring-cyborg boring-cyborg bot added area:dev-tools provider:cncf-kubernetes Kubernetes provider related issues area:providers provider:Apache provider:google Google (including GCP) related issues labels Jun 11, 2021
@potiuk potiuk requested review from eladkal and msumit June 11, 2021 22:47
@kaxil
Copy link
Member

kaxil commented Jun 12, 2021

Some static checks and Pylint are failing

@potiuk
Copy link
Member Author

potiuk commented Jun 12, 2021

Some static checks and Pylint are failing

On it. I also wanted to add some more explicit comment about Airlow 2.1+compatibility in the CHANGELOGS.

@potiuk
Copy link
Member Author

potiuk commented Jun 12, 2021

@kaxil

  • Added an explicit WARNING with 2.1 compatibility in changelogs/docs
  • Fixed a new pylint error (unrelated and "random" as it happens with pylint, so I updated it)
  • The static checks turned out to be lack of tags in the fetched git repo in static check job (we are using it verify if all the changes since previous release are present in the CHANGELOG/index.rst for provider where changelog is automatically included - this way we can be sure we have not missed any change)- fixed it with adding fetch-depth 0 in static-checks job.

@potiuk
Copy link
Member Author

potiuk commented Jun 12, 2021

I also realized that I do not have to copy the changelog but I can include it in the idex.rst so I fixed this. Also fixed the "suggest
a change" link -> apache/airflow-site#417

@potiuk potiuk force-pushed the update-documentation-more-updates-for-june-2021-providers-release branch 2 times, most recently from 9cd27e4 to 4a581f9 Compare June 12, 2021 20:52
@potiuk potiuk force-pushed the update-documentation-more-updates-for-june-2021-providers-release branch 6 times, most recently from 51f1f03 to e7adbe2 Compare June 12, 2021 22:46
@potiuk potiuk force-pushed the update-documentation-more-updates-for-june-2021-providers-release branch 2 times, most recently from be54c94 to 5866bd9 Compare June 12, 2021 23:53
@potiuk potiuk force-pushed the update-documentation-more-updates-for-june-2021-providers-release branch from 5866bd9 to f7b7a83 Compare June 13, 2021 00:39
@potiuk
Copy link
Member Author

potiuk commented Jun 13, 2021

Sounds like just unrelated MSSQL random problem @kaxil (and I also incorporated few last merges for some simple/straightforward fixes that waited for approval).
I've gone through several iterations of that and rebasing/updating the PR and it seems to work really nice now with ..include of changelog and commented out issues/chores that should not be included in the changelog. The changelog update works hand-in-hand with the upcoming #16419 to generate the "test status" issue and we have a really nice way to manage and verify that we have not forgotten some changes in changelogs + get the community-driven testing via the issue with test status in an easy way to prepare and manage for release manager.

@potiuk potiuk force-pushed the update-documentation-more-updates-for-june-2021-providers-release branch from f7b7a83 to 7474340 Compare June 13, 2021 10:58
@potiuk potiuk force-pushed the update-documentation-more-updates-for-june-2021-providers-release branch 2 times, most recently from e4f8e75 to f76eb0b Compare June 13, 2021 12:44
@potiuk
Copy link
Member Author

potiuk commented Jun 13, 2021

All green and ready to merge!

@potiuk potiuk force-pushed the update-documentation-more-updates-for-june-2021-providers-release branch from f76eb0b to f905b67 Compare June 13, 2021 20:26
@github-actions
Copy link

The PR most likely needs to run full matrix of tests because it modifies parts of the core of Airflow. However, committers might decide to merge it quickly and take the risk. If they don't merge it quickly - please rebase it to the latest main at your convenience, or amend the last commit of the PR, and push it with --force-with-lease.

@github-actions github-actions bot added the full tests needed We need to run full set of tests for this PR to merge label Jun 14, 2021
@potiuk potiuk force-pushed the update-documentation-more-updates-for-june-2021-providers-release branch from f905b67 to fb8733b Compare June 14, 2021 12:48
The provider changelogs were already merged but they could not be
released due to unavailability of signing key in remote location
The documentation has once more been updated, including latest
merges - documentation-only changes were removed from
bugs/feetures/breaking changes lists.

Few other improvements:

* Pre-commit was added to make sure that the documentation
  in provider's index.rst files includes the latest changelog.
* Index.rst now contain includes of the CHANGELOG.rst rather
  than copy of the CHANGELOG.rst
* The `prepare-provider-package` breeze command has --non-interactive
  flag now
* generated provider package README.rst contain changelog so you can
  see the changelog directly in PyPI
* "Suggest change on this page" link in documentation is fixed.
@potiuk potiuk force-pushed the update-documentation-more-updates-for-june-2021-providers-release branch from fb8733b to 0a40653 Compare June 15, 2021 08:23
@potiuk potiuk merged commit 1fba540 into apache:main Jun 15, 2021
@potiuk potiuk deleted the update-documentation-more-updates-for-june-2021-providers-release branch June 15, 2021 08:34
potiuk added a commit to potiuk/airflow that referenced this pull request Jun 22, 2021
The provider changelogs were already merged but they could not be
released due to unavailability of signing key in remote location
The documentation has once more been updated, including latest
merges - documentation-only changes were removed from
bugs/feetures/breaking changes lists.

Few other improvements:

* Pre-commit was added to make sure that the documentation
  in provider's index.rst files includes the latest changelog.
* Index.rst now contain includes of the CHANGELOG.rst rather
  than copy of the CHANGELOG.rst
* The `prepare-provider-package` breeze command has --non-interactive
  flag now
* generated provider package README.rst contain changelog so you can
  see the changelog directly in PyPI
* "Suggest change on this page" link in documentation is fixed.

(cherry picked from commit 1fba540)
@potiuk potiuk restored the update-documentation-more-updates-for-june-2021-providers-release branch April 26, 2022 20:54
@potiuk potiuk deleted the update-documentation-more-updates-for-june-2021-providers-release branch July 29, 2022 20:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:dev-tools area:providers full tests needed We need to run full set of tests for this PR to merge provider:cncf-kubernetes Kubernetes provider related issues provider:google Google (including GCP) related issues
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants