Add check to ensure BC breaking changes in rest descriptors are caught
Nobody has claimed this yet.
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 25/100
Research direction
Start by reviewing the linked Batch library change in pull request 6208 and the existing Surface Breaking Change Detector. Compare the proposed rest-configuration artifact approach with a separate Configuration Breaking Change Detector, and define which descriptor changes must be detected for the work to be complete.
Written by the indexing model from the issue text.
Description
This change in the Batch library was not caught by our Breaking Change detector because it's a configuration change rather than a PHP surface change.
I see two solutions to this:
- Make the GAPIC generator create a surface artifact for rest configuration. Removal of these surface changes would be caught by the breaking change detector. This is similar to what we have in the
Connectionclasses, where each method is implemented in aConnection/Restclass. The downside to this is it would create a LOT of overhead and also require a significant amount of work/changes in the generator, which would result in a lot of churn.
- Write a "Configuration Breaking Change Detector" that runs alongside the existing "Surface Breaking Change Detector". This could be expanded to check breaking changes in any descriptor config files.
- Dominant language
- PHP
- Stars
- 1.2k
- Forks
- 464
- Avg merge
- 2d 2h
- Merged PRs (30d)
- 103
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from googleapis/google-cloud-php
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
googleapis/google-cloud-php#9730 ·
-
type: feature request
Difficulty 1/5 Under an hour Newbie friendliness 75/100
googleapis/google-cloud-php#9716 · 11 reactions ·
-
Difficulty 3/5 1-2 days Newbie friendliness 65/100
googleapis/google-cloud-php#9725 ·
-
Difficulty 5/5 Over a week Newbie friendliness 25/100
googleapis/google-cloud-php#9675 · 1 comment ·
-
Difficulty 4/5 3-5 days Newbie friendliness 55/100
googleapis/google-cloud-php#9674 · 1 comment ·
All issues in googleapis/google-cloud-php
Similar issues
-
tooling
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
-
UX
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
ProfessionalWiki/NeoWiki#1525 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
-
Difficulty 1/5 Under an hour Newbie friendliness 90/100
OpenConext/OpenConext-engineblock#2122 ·
-
Bug
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
Automattic/safe-publish#594 ·