-
Notifications
You must be signed in to change notification settings - Fork 1.2k
Use 'line' instead of 'position' #1566
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
Use 'line' instead of 'position' #1566
Conversation
|
I've approved the Actions runs; thank you for submitting! I'm slightly torn about this: I think this is a breaking change since the signature of |
|
Well...You're right! It may not be possible to provide an override because we're just changing the parameter name, and the type remains the same. So I think we have no choice but to release it in the next major version. |
|
Hmm...I'm not loving any of these options, really. Perhaps the best thing to do is note in comments/docs that "position" will go away in favor of "line" in the next major version, and save this PR up for when we cut a new major version. |
|
I see, understood! Thanks! |
|
Would you consider adding an interim method which uses the new API request format? Continuing to use the By adopting the My workaround is to call directly into the API: octokit.post(
"#{Octokit::Repository.path("user/repo")}/pulls/#{pull_id}/comments",
{
body: body,
commit_id: commit_id,
path: path,
line: line,
side: 'RIGHT'
}
) |
|
When we merge #1596, we can/should also take this PR before cutting a breaking change. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think the deprecation notice has been baking long enough and we can release this breaking change now!
Resolves #1565
Behavior
Before the change?
After the change?
Other information
Additional info
Pull request checklist
Does this introduce a breaking change?
Please see our docs on breaking changes to help!
Type: Breaking changelabel)If
Yes, what's the impact:Pull request type
Please add the corresponding label for change this PR introduces:
Type: BugType: FeatureType: DocumentationType: Maintenance