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

Implement changes to Checks API for Annotations models and re-request endpoint #1857

Merged
merged 7 commits into from
Sep 3, 2018

Conversation

ryangribble
Copy link
Contributor

@ryangribble ryangribble commented Aug 23, 2018

Fixes #1856

Attempt to handle both old and new annotations models so we can support github.com and GHE 2.14

  • add Path and AnnotationLevel fields to CheckRunAnnotation response and NewCheckRunAnnotation request
  • flag Filename and WarningLevel as deprecated/obsolete but keep them around so we can use them for GHE 2.14
  • also flag BlobHref as deprecated on NewCheckRunAnnotation
  • Adjust ctors so we have a way to create the "old" and "new" model formats, ensuring the relevant fields are null so they don't get sent
  • Add new re-request endpoint
  • Flag old request endpoint for deprecation

…he changes on github.com as well as still support GHE2.14

add Path and AnnotationLevel fields
flag Filename and WarningLevel as deprecated/obsolete
also flag BlobHref as deprecated on NewCheckRunAnnotation
Adjust ctors to handle new and legacy field options
@ryangribble
Copy link
Contributor Author

I think I've managed to get these changes done to support github.com and also leave the old models/methods intact to continue supporting GHE 2.14

@shiftkey @StanleyGoldman could you cast your 👀 over this just to double check? 🙏

…on response and NewCheckRunAnnotation request
@ryangribble
Copy link
Contributor Author

ryangribble commented Sep 3, 2018

release_notes: Implement new/changed fields on CheckRunAnnotation response and NewCheckRunAnnotation request models - replace Filename with Path, WarningLevel with AnnotationLevel and add StartColumn and EndColumn

@ryangribble
Copy link
Contributor Author

ryangribble commented Sep 3, 2018

advisories: Due to upstream breaking changes in the CheckRuns API, using check runs against github.com will require using the new/renamed fields on CheckRunAnnotation response and NewCheckRunAnnotation request models. However the old fields are maintained in octokit.net (marked as deprecated) to continue supporting GitHub Enterprise 2.14, which will not receive these changes. Users of GHE 2.14 should use the old fields, whilst users of github.com should update to use the new fields

@ryangribble
Copy link
Contributor Author

ryangribble commented Sep 3, 2018

release_notes: Add new method CheckSuitesClient.Rerequest() and mark the old CheckSuitesClient.Request() method as deprecated (this will no longer function on github.com but will continue to be supported on GitHub Enterprise 2.14)

@ryangribble ryangribble merged commit d166a8c into master Sep 3, 2018
@ryangribble ryangribble deleted the check-run-changes branch September 3, 2018 10:52
@nickfloyd nickfloyd added Type: Feature New feature or request and removed category: feature labels Oct 27, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Type: Feature New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants