docs: Add clarifications for mergeable field in pull requests #3396
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
gmlewis
changed the title
gmlewis
requested changes
Dec 21, 2024
acouvreur
force-pushed
the
add-mergeable-clarifications
branch
from
d505fe2 to
ca738b7
Compare
|
It is now one single block comment @gmlewis |
|
Please run the scripts listed in step 4 of CONTRIBUTING.md and push the changes. That should fix the linter and tests. |
|
I will close this PR around the end of January, 2025 as "abandoned" if there is no further response. |
acouvreur
force-pushed
the
add-mergeable-clarifications
branch
from
ca738b7 to
dd2c798
Compare
Done just in time :) |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #3396 +/- ##
=======================================
Coverage 91.03% 91.03%
=======================================
Files 179 179
Lines 15535 15535
=======================================
Hits 14142 14142
Misses 1221 1221
Partials 172 172 ☔ View full report in Codecov by Sentry. |
gmlewis
approved these changes
Jan 30, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Comparing the OpenAPI spec for pull requests shows that these fields are not populated when listing (right), but they are through GET or webhook:
In their OpenAPI Spec they have
pull-requestandpull-request-simpledefinitions.I think that would make sense to also have these structs instead of relying on comments for contextual field population.