https://github.com/oldhammade/reviewdog-action-sobelow
Run sobelow with reviewdog
https://github.com/oldhammade/reviewdog-action-sobelow
Last synced: about 2 months ago
JSON representation
Run sobelow with reviewdog
- Host: GitHub
- URL: https://github.com/oldhammade/reviewdog-action-sobelow
- Owner: OldhamMade
- Created: 2021-05-27T12:11:07.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2021-05-27T12:12:13.000Z (almost 4 years ago)
- Last Synced: 2025-02-27T21:30:29.196Z (2 months ago)
- Language: Dockerfile
- Size: 2.93 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# GitHub Action: Run sobelow with reviewdog
[![Docker Image CI][docker-image-ci]][urls-action]
[![Release][images-release]][urls-releases]
This action runs [sobelow][urls-sobelow] with
[reviewdog][urls-reviewdog] on pull requests to improve code review
experience.
This action is **heavily** based on
[`review-action-credo`][url-review-action-credo] from the gang at
[red-shirts][url-red-shirts].
## Inputs
### `github_token`
**Required**. Must be in form of `github_token: ${{ secrets.github_token }}`'.
### `level`
Optional. Report level for reviewdog [info,warning,error].
It's same as `-level` flag of reviewdog.
### `reporter`
Reporter of reviewdog command [github-pr-check,github-pr-review].
Default is github-pr-check.
github-pr-review can use Markdown and add a link to rule page in reviewdog reports.
## Example usage
### [.github/workflows/reviewdog.yml](.github/workflows/reviewdog.yml)
```yml
name: reviewdog
on: [pull_request]
jobs:
sobelow:
name: runner / sobelow
runs-on: ubuntu-latest
container:
image: elixir:1.9.1-slim
steps:
- uses: actions/checkout@v1
- name: Install Dependencies
run: |
mix local.rebar --force
mix local.hex --force
mix deps.get
- name: sobelow
uses: OldhamMade/reviewdog-action-sobelow@v1
with:
github_token: ${{ secrets.github_token }}
reporter: github-pr-review # Change reporter.
```
[docker-image-ci]: https://github.com/OldhamMade/reviewdog-action-sobelow/workflows/Docker%20Image%20CI/badge.svg
[images-release]: https://img.shields.io/github/release/OldhamMade/reviewdog-action-sobelow.svg?maxAge=43200
[urls-action]: https://github.com/OldhamMade/reviewdog-action-sobelow/actions
[urls-releases]: https://github.com/OldhamMade/reviewdog-action-sobelow/releases
[urls-sobelow]: https://github.com/rrrene/sobelow
[urls-reviewdog]: https://github.com/reviewdog/reviewdog
[urls-review-action-credo]: https://github.com/red-shirts/reviewdog-action-credo
[urls-red-shirts]: https://github.com/red-shirts