https://github.com/reviewdog/action-vint

Run vint with reviewdog
https://github.com/reviewdog/action-vint

reviewdog vint

Last synced: 3 months ago
JSON representation

Run vint with reviewdog

• Host: GitHub
• URL: https://github.com/reviewdog/action-vint
• Owner: reviewdog
• License: mit
• Created: 2019-09-23T08:48:08.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2024-10-08T01:01:21.000Z (4 months ago)
• Last Synced: 2024-10-18T00:41:34.572Z (4 months ago)
• Topics: reviewdog, vint
• Language: Dockerfile
• Homepage: https://github.com/marketplace?type=actions&query=reviewdog
• Size: 60.5 KB
• Stars: 10
• Watchers: 32
• Forks: 2
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-actions - Run vint, with reviewdog output on the PR
• fucking-awesome-actions - Run vint, with reviewdog output on the PR
• awesome-workflows - Run vint, with reviewdog output on the PR

README

        
# GitHub Action: Run vint with reviewdog

[![Docker Image CI](https://github.com/reviewdog/action-vint/workflows/Docker%20Image%20CI/badge.svg)](https://github.com/reviewdog/action-vint/actions)

[![depup](https://github.com/reviewdog/action-vint/workflows/depup/badge.svg)](https://github.com/reviewdog/action-vint/actions?query=workflow%3Adepup)

[![release](https://github.com/reviewdog/action-vint/workflows/release/badge.svg)](https://github.com/reviewdog/action-vint/actions?query=workflow%3Arelease)

[![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/reviewdog/action-vint?logo=github&sort=semver)](https://github.com/reviewdog/action-vint/releases)

[![action-bumpr supported](https://img.shields.io/badge/bumpr-supported-ff69b4?logo=github&link=https://github.com/haya14busa/action-bumpr)](https://github.com/haya14busa/action-bumpr)

This action runs [vint](https://github.com/Kuniwak/vint) with

[reviewdog](https://github.com/reviewdog/reviewdog) on pull requests to improve

code review experience.

[![github-pr-check example](https://user-images.githubusercontent.com/3797062/65413404-57887a00-de2c-11e9-8f45-0729808b1c29.png)](https://github.com/reviewdog/action-vint/pull/1)

[![github-pr-review example](https://user-images.githubusercontent.com/3797062/65413352-3f185f80-de2c-11e9-956e-569eeaccac5f.png)](https://github.com/reviewdog/action-vint/pull/1)

## 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:

  vint:

    name: runner / vint

    runs-on: ubuntu-latest

    steps:

      - uses: actions/checkout@v4

      - name: vint

        uses: reviewdog/action-vint@v1

        with:

          github_token: ${{ secrets.github_token }}

          reporter: github-pr-review # Change reporter.

```