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

add compatibility check badges to README #691

Merged
merged 1 commit into from Jun 10, 2019

Conversation

Projects
None yet
3 participants
@ylil93
Copy link
Contributor

commented Jun 6, 2019

Hello google package maintainer,
The badges being added to the README in this PR will indicate your 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 this one are self and pairwise compatible as well as not having any deprecated dependencies. The two badges 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. 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

@googlebot googlebot added the cla: yes label Jun 6, 2019

@busunkim96

This comment has been minimized.

Copy link
Contributor

commented Jun 6, 2019

Hey @ylil93, could you open up permissions for the badging PRD?

@ylil93

This comment has been minimized.

Copy link
Contributor Author

commented Jun 6, 2019

Hey @ylil93, could you open up permissions for the badging PRD?

Sorry about that! And done!

@busunkim96 busunkim96 merged commit d82f3e7 into googleapis:master Jun 10, 2019

1 of 2 checks passed

security/snyk - samples/django_sample/requirements.txt (googleapis) Manifest not found
Details
cla/google All necessary CLAs are signed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.