Fix compatibility issue with Octokit >= 8 #1479
Merged
Conversation
This file contains 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
manicmaniac
commented
Feb 1, 2024
| expect(@g.client).to receive(:delete_comment).with("artsy/eigen", inline_issue_id_2).and_return({}) | ||
| expect(@g.client).to receive(:delete_comment).with("artsy/eigen", main_issue_id).and_return({}) | ||
|
|
||
| v = Danger::Violation.new("Sure thing", true, "Rakefile", 34) |
There was a problem hiding this comment.
The following diff is used as test fixture.
manicmaniac
force-pushed
the
compatibility-with-octokit-v7
branch
from
0d303da
to
5cb00a3
Compare
manicmaniac
changed the title
manicmaniac
force-pushed
the
compatibility-with-octokit-v7
branch
from
5cb00a3
to
f8c2eb5
Compare
manicmaniac
commented
Feb 1, 2024
| client.create_pull_request_comment(ci_source.repo_slug, ci_source.pull_request_id, | ||
| body, head_ref, m.file, position) | ||
| body, head_ref, m.file, (Octokit::MAJOR >= 8 ? m.line : position)) |
There was a problem hiding this comment.
Octokit::MAJOR exists since Octokit v4.0.0 and it is the minimum version that Danger supports.
Line 31 in bd89c4d
manicmaniac
force-pushed
the
compatibility-with-octokit-v7
branch
from
f8c2eb5
to
bf46822
Compare
|
@orta Could you give me a quick review on this one? |
orta
approved these changes
Feb 3, 2024
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.
Overview
Close #1475
Currently Danger cannot post an inline comment when it is installed with Octokit >= 8.
It is because that Octokit has changed the method signature of
create_pull_request_comment()(octokit/octokit.rb@918af86).This PR fixes this issue by changing arguments depends on Octokit version.
Test
I added 2 specs to confirm that Danger changes its behavior depends on Octokit version.
And I also confirmed that this PR fixes the issue in other repository.
manicmaniac/danger-issue-1475#6
Bug / Known issues
The branch name of this PR is wrong. The change of method signature was introduced in Octokit v8, not v7.