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.

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

Example PR using woke-action-reviewdog and github-pr-review #2

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Example PR using woke-action-reviewdog and github-pr-review #2

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
74cc412
Add violations
caitlinelfring Sep 9, 2020
9d8b972
Add `get-woke/woke-action-reviewdog@v0` with `github-pr-review` reporter
caitlinelfring Sep 9, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions .github/workflows/woke.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
name: woke
on: [pull_request]

jobs:
woke:
name: runner / woke
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: get-woke/woke-action-reviewdog@v0
with:
github-token: ${{ secrets.GITHUB_TOKEN }}
# NOTE: This reporter will create new comments for each check run
# where violations exist. This can cause a PR conversation to get
# quite crowded. See https://github.com/reviewdog/reviewdog/issues/568
reporter: github-pr-review

# Enable to fail the PR check
fail-on-error: true

# GitHub Status Check won't become failure with violations
# that have severity warn when using level: warning
# level: error

# Change the filter mode
# See https://github.com/reviewdog/reviewdog#filter-mode
# filter-mode: added
10 changes: 10 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,13 @@ This repo contains example PRs for using [`woke`](https://getwoke.tech) GitHub A

- [GitHub Action](https://github.com/marketplace/actions/run-woke)
- [GitHub Action (reviewdog)](https://github.com/marketplace/actions/run-woke-with-reviewdog)

## Violations

- whitelist
Copy link

Choose a reason for hiding this comment

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

[woke] reported by reviewdog 🐶
[warning] whitelist may be insensitive, use allowlist instead

- blacklist
Copy link

Choose a reason for hiding this comment

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

[woke] reported by reviewdog 🐶
[warning] blacklist may be insensitive, use denylist, blocklist instead

- guys <!--wokeignore:rule=guys -->
- sanity check
Copy link

Choose a reason for hiding this comment

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

[woke] reported by reviewdog 🐶
[error] sanity may be insensitive, use confidence, quick check, coherence check instead

- grandfathered
Copy link

Choose a reason for hiding this comment

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

[woke] reported by reviewdog 🐶
[error] grandfathered may be insensitive, use legacy status instead

- man-hours
Copy link

Choose a reason for hiding this comment

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

[woke] reported by reviewdog 🐶
[error] man-hours may be insensitive, use person hours, engineer hours instead

- dummy value
Copy link

Choose a reason for hiding this comment

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

[woke] reported by reviewdog 🐶
[error] dummy may be insensitive, use placeholder, sample instead