Skip to content

Explicit annotation reporter #1623

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 2 commits into from
Jan 11, 2024
Merged

Explicit annotation reporter #1623

merged 2 commits into from
Jan 11, 2024

Conversation

mheap
Copy link
Contributor

@mheap mheap commented Dec 7, 2023

Feature Description

This PR adds a new github-pr-annotations reporter which bypasses the checks API and uses the existing GitHub annotations fallback to report failures.

It should resolve #403 and allow people to attach annotations in the same check that runs reviewdog.

Testing

I've updated all existing tests so that they pass again. I tried to add a test for the GH Actions annotation format specifically, but core.Error in go-actions-toolkit is hardcoded to write to os.stdout which means I can't capture the output to write assertions

Checklist

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

mheap
mheap commented Dec 7, 2023
View reviewed changes
mheap
mheap commented Dec 7, 2023
View reviewed changes
@mheap mheap marked this pull request as draft December 7, 2023 13:18
@mheap
Copy link
Contributor Author

mheap commented Dec 7, 2023

It looks as though the doghouse server tests need updating too. I can do that if this PR looks like something you would want to accept

@mheap
Copy link
Contributor Author

mheap commented Jan 9, 2024

@shogo82148 Is this functionality of interest?

@shogo82148
Copy link
Contributor

Yes, I'm interested.

@mheap mheap force-pushed the explicit-annotation-reporter branch from 550c9d0 to 9a4b6d6 Compare January 11, 2024 09:31
@mheap mheap marked this pull request as ready for review January 11, 2024 09:32
@mheap
Copy link
Contributor Author

mheap commented Jan 11, 2024

@shogo82148 All tests are passing for me locally. Please approve workflows on this PR so that I can see other checks

@mheap mheap force-pushed the explicit-annotation-reporter branch 2 times, most recently from 27a3a73 to fc351ea Compare January 11, 2024 09:33
@mheap mheap force-pushed the explicit-annotation-reporter branch from fc351ea to 0b9c1a2 Compare January 11, 2024 09:34
@mheap
Copy link
Contributor Author

mheap commented Jan 11, 2024

I should also mention that we've been running a fork containing this change with Vale since December to great effect.

Example failure: https://github.com/Kong/docs.konghq.com/actions/runs/7462192691

shogo82148
shogo82148 approved these changes Jan 11, 2024
View reviewed changes
Copy link
Contributor

@shogo82148 shogo82148 left a comment

Choose a reason for hiding this comment

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

LGTM

@shogo82148 shogo82148 merged commit b3c1fc4 into reviewdog:master Jan 11, 2024
@review-dog
Copy link
Member

Hi, @mheap! We merged your PR to reviewdog! 🐶
Thank you for your contribution! ✨

We just invited you to join the @reviewdog organization on GitHub.
Accept the invite by visiting https://github.com/orgs/reviewdog/invitation.
By joining the team, you'll be a part of reviewdog community and can help the maintenance of reviewdog.

Thanks again!

@mheap mheap deleted the explicit-annotation-reporter branch January 11, 2024 11:02
@shogo82148 shogo82148 mentioned this pull request Jan 14, 2024
Closed
@javierjulio javierjulio mentioned this pull request Feb 12, 2024
Merged
@Drowze
Copy link
Contributor

Drowze commented Feb 20, 2024

Love this! Just became aware of this change. Clever approach 😄

@javierjulio javierjulio mentioned this pull request Feb 23, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@shogo82148 shogo82148 shogo82148 approved these changes

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

Successfully merging this pull request may close these issues.

Check runs gets added to the wrong check suite
4 participants
@mheap @shogo82148 @review-dog @Drowze