Skip to content

github-pr-review: Support range suggestions #698

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 10 commits into from
Jul 25, 2020
Merged

github-pr-review: Support range suggestions #698

merged 10 commits into from
Jul 25, 2020

Conversation

haya14busa
Copy link
Member

@haya14busa haya14busa commented Jul 25, 2020 •
edited
Loading

  • Updated Unreleased section in CHANGELOG or it's not notable changes.

github-actions[bot]
github-actions bot reviewed Jul 25, 2020
View reviewed changes
_testdata/suggestions.txt
@@ -0,0 +1,16 @@
package testdata

func suggestions() {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[suggestion-test] reported by reviewdog 🐶
suggestion test

Suggested change
func suggestions() {
func Suggestions() {

_testdata/suggestions.txt
Comment on lines +3 to +4
func suggestions() {
}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[suggestion-test] reported by reviewdog 🐶
multiline suggestion test

Suggested change
func suggestions() {
}
func Suggestions() {
// Multiline suggestion!
} // end of suggestion func

_testdata/suggestions.txt
func suggestions() {
}

haya13busa (replace)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[suggestion-test] reported by reviewdog 🐶
range suggestion test (replace)

Suggested change
haya13busa (replace)
haya14busa (replace)

_testdata/suggestions.txt
}

haya13busa (replace)
hayabusa (insert)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[suggestion-test] reported by reviewdog 🐶
range suggestion test (insert)

Suggested change
hayabusa (insert)
haya14busa (insert)

_testdata/suggestions.txt

haya13busa (replace)
hayabusa (insert)
haya14busa (remove)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[suggestion-test] reported by reviewdog 🐶
range suggestion test (remove)

Suggested change
haya14busa (remove)
hayabusa (remove)

_testdata/suggestions.txt
Comment on lines +10 to +11
--->
<--- (remove line-break)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[suggestion-test] reported by reviewdog 🐶
range suggestion test (remove line-break)

Suggested change
--->
<--- (remove line-break)
---><--- (remove line-break)

_testdata/suggestions.txt
--->
<--- (remove line-break)

remove line
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[suggestion-test] reported by reviewdog 🐶
suggestion test (remove line)

Suggested change
remove line

_testdata/suggestions.txt
remove line

insert line ↓
insert line ↑
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[suggestion-test] reported by reviewdog 🐶
suggestion test (insert line)
Invalid suggestion: invalid source lines: not all source lines for this suggestion are available

github-actions[bot]
github-actions bot reviewed Jul 25, 2020
View reviewed changes
_testdata/suggestions.txt
remove line

insert line ↓
insert line ↑
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[suggestion-test] reported by reviewdog 🐶
suggestion test (insert line)

Suggested change
insert line ↑
inserted line 1
inserted line 2
insert line ↑

github-actions[bot]
github-actions bot reviewed Jul 25, 2020
View reviewed changes
_testdata/suggestions.txt
remove line

insert line ↓
insert line ↑
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[suggestion-test] reported by reviewdog 🐶
suggestion test (invalid)

reviewdog suggestion errorthe Diagnostic's lines and Suggestion lines must be the same. 16-0 v.s. 17-0

github-actions[bot]
github-actions bot reviewed Jul 25, 2020
View reviewed changes
_testdata/suggestions.txt
remove line

insert line ↓
insert line ↑
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[suggestion-test] reported by reviewdog 🐶
suggestion test (invalid)

reviewdog suggestion errorthe Diagnostic's lines and Suggestion lines must be the same. L16-L0 v.s. L17-L0

github-actions[bot]
github-actions bot reviewed Jul 25, 2020
View reviewed changes
_testdata/suggestions.txt
func suggestions() {
}

haya13busa (replace)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[suggestion-test] reported by reviewdog 🐶
suggestion test (multiple suggestions)

Suggested change
haya13busa (replace)
haya14busa (replace)
Suggested change
haya13busa (replace)
haya1busa (replace)
Suggested change
haya13busa (replace)
haya2busa (replace)

@haya14busa haya14busa merged commit 0b15961 into master Jul 25, 2020
@haya14busa haya14busa deleted the github-non-line-based-suggestion branch July 25, 2020 19:38
@haya14busa haya14busa mentioned this pull request Jul 26, 2020
Open
6 tasks
KikeE36 added a commit to KikeE36/reviewdog that referenced this pull request Feb 22, 2021
@KikeE36
https://github.com/reviewdog/reviewdog/tree/reviewdog:master
e9f3c00 
https://github.com/reviewdog/reviewdog/tree/reviewdog:master
# Changelog
All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [Unreleased]

### ✨ Release Note <!-- optional -->

### 🚀 Enhancements
- [reviewdog#888](reviewdog#888) Allow GitHub PR reporting for a forked repository iff it's triggered by `pull_request_target`

### 🐛 Fixes
- ...

### 🚨 Breaking changes
- ...

---

## [v0.11.0] - 2020-10-25

### ✨ Release Note
reviewdog v0.11 introduced [Reviewdog Diagnostic Format (RDFormat)](./README.md#reviewdog-diagnostic-format-rdformat)
as generic machine-readable diagnostic format and it unlocks new rich features like code suggestions.

### 🚀 Enhancements
- [reviewdog#629](reviewdog#629) Introduced Reviewdog Diagnostic Format.
 - [reviewdog#674](reviewdog#674) [reviewdog#703](reviewdog#703) Support rdjsonl/rdjson as input format
 - [reviewdog#680](reviewdog#680) github-pr-review: Support multiline comments
 - [reviewdog#675](reviewdog#675) [reviewdog#698](reviewdog#698) github-pr-review: Support suggested changes
 - [reviewdog#699](reviewdog#699) Support diff input format (`-f=diff`). Useful for suggested changes.
 - [reviewdog#700](reviewdog#700) Support to show code(rule), code URL and severity in GitHub and GitLab reporters.
- [reviewdog#678](reviewdog#678) github-pr-review: Support Code Suggestions
  - Introduced [reviewdog/action-suggester](https://github.com/reviewdog/action-suggester) action.
- Introduced [reviewdog/action-setup](https://github.com/reviewdog/action-setup) GitHub Action which installs reviewdog easily including nightly release.
- [reviewdog#769](reviewdog#769) Integration with [Bitbucket Code Insights](https://support.atlassian.com/bitbucket-cloud/docs/code-insights/) and [Bitbucket Pipelines](https://bitbucket.org/product/ru/features/pipelines)

---

## [v0.10.2] - 2020-08-04

### 🐛 Fixes
- [reviewdog#709](reviewdog#709) Check for GITHUB_ACTIONS instead of GITHUB_ACTION

---

## [v0.10.1] - 2020-06-30

### 🚀 Enhancements
- [reviewdog#563](reviewdog#563) Use `CI_API_V4_URL` environment variable when present.

### 🐛 Fixes
- [reviewdog#609](reviewdog#609) reviewdog command will fail with unexpected tool's error for github-check/github-pr-check reporters as well. ([@haya14busa])
- [reviewdog#603](reviewdog#603) Fixed detection of Pull Requests from forked repo. ([@haya14busa])

---

## [v0.10.0] - 2020-05-07

### ✨ Release Note

With v0.10.0 release, now reviewdog can find issues outside diff by controlling
filtering behavior with `-filter-mode`. Also, you can ensure to check reported
results by exit 1 with `-fail-on-error`.

Example
```shell
$ cd subdir/ && reviewdog -filter-mode=file -fail-on-error -reporter=github-pr-review
```

### 🚀 Enhancements
- [reviewdog#446](reviewdog#446)
  Added `-fail-on-error` flag
  ([document](https://github.com/reviewdog/reviewdog/tree/e359505275143ec85e9b114fc1ab4a4e91d04fb5#exit-codes))
  and improved exit code handling. ([@DmitryLanda](https://github.com/DmitryLanda), [@haya14busa])
- [reviewdog#187](reviewdog#187)
  Added `-filter-mode` flag [`added`, `diff_context`, `file`, `nofilter`]
  ([document](https://github.com/reviewdog/reviewdog/tree/e359505275143ec85e9b114fc1ab4a4e91d04fb5#filter-mode))
  which controls how reviewdog filter results. ([@Le6ow5k1](https://github.com/Le6ow5k1), [@haya14busa])
- [reviewdog#69](reviewdog#69) Support gerrit! ([@staticmukesh](https://github.com/staticmukesh))
- [reviewdog#548](reviewdog#548) Introduced nightly release ([reviewdog/nightly](https://github.com/reviewdog/nightly)). ([@haya14busa])

### 🐛 Fixes
- [reviewdog#461](reviewdog#461) All reporters now supports sub-directory run. ([@haya14busa])

### 🚨 Breaking changes
- `github-check` reporter won't report results outside diff by default now. You
  need to use `-filter-mode=nofilter` to keep the same bahavior.

---

See https://github.com/reviewdog/reviewdog/releases for older release note.

[Unreleased]: reviewdog/reviewdog@v0.10.0...HEAD
[v0.10.0]: reviewdog/reviewdog@v0.9.17...v0.10.0
[v0.10.1]: reviewdog/reviewdog@v0.10.0...v0.10.1
[v0.10.2]: reviewdog/reviewdog@v0.10.1...v0.10.2
[v0.11.0]: reviewdog/reviewdog@v0.10.2...v0.11.0
[@haya14busa]: https://github.com/haya14busa
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@github-actions github-actions[bot] github-actions[bot] left review comments

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@haya14busa