Docs: Add compatibility check badges to READMEs.#8288
Docs: Add compatibility check badges to READMEs.#8288tseaver merged 45 commits intogoogleapis:masterfrom
Conversation
I'm not sure what these mean... Could I have some clarification? From my point of view, this change only touches README files, so I don't see how it could be the cause of any of these breakages. |
When reviewing a PR, we need to note the source of any CI failures, even those unrelated to the changes made by the PR. |
|
The CircleCI job actually completed successfully. |
|
@ylil93 Can you please explain the utility of the flags? For instance, on the |
If you navigate to the badge target by clicking on it, you'll see an explanation for the incompatible status. Py2 errors will include a deprecation warning, but we do not trigger errors based on this warning, however it is included in the error description. Feel free to ignore them. For PyPI, In other words, For the github badge, the repo is incompatible with several other google packages for similar reasons. The flags you should care about are: |
Hello google package maintainers,
The badges being added to the READMEs in this PR will indicate each package's compatibility with other google packages. This addresses a set of user bugs which have happened when a user depends on two Cloud libraries (or runtimes that bundle libraries), say A and B, which both depend on library C. If the two libraries require different versions of C, the users can run into issues both when they pip install the libraries, and when they deploy their code. Our compatibility server checks that all libraries we make including these ones are self and pairwise compatible as well as not having any deprecated dependencies. The two badges being added to each README will mark the build for your project green when the latest version available on PyPI and github HEAD respectively meet all compatibility checks with itself and all other libraries. The badge target will link to a details page that elaborates on the current status. This should help you fix issues pre-release, to avoid user surprises. For more information, please take a look at our project charter at go/python-cloud-dependencies-project-charter and the badging PRD https://docs.google.com/document/d/1GYRFrfUou2ssY71AtnLkc8Sg1SD4dxqN4GzlatGHHyI/edit?ts=5c6f031d