Skip to content

Commit

Permalink
🔀 Merge pull request #8 from rickstaa/fixes_readme_badges
Browse files Browse the repository at this point in the history
📝 Fixes the README.md badges
  • Loading branch information
rickstaa authored Dec 19, 2020
2 parents 83ff06b + 534ffa1 commit 8d4eb9c
Showing 1 changed file with 10 additions and 13 deletions.
23 changes: 10 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,11 @@
# Reviewdog/action-remark-lint GitHub Action

[![Test](https://github.com/prologic/action-remark-lintworkflows/Test/badge.svg)](https://github.com/prologic/action-remark-lintactions?query=workflow%3ATest)
[![reviewdog](https://github.com/prologic/action-remark-lintworkflows/reviewdog/badge.svg)](https://github.com/prologic/action-remark-lintactions?query=workflow%3Areviewdog)
[![depup](https://github.com/prologic/action-remark-lintworkflows/depup/badge.svg)](https://github.com/prologic/action-remark-lintactions?query=workflow%3Adepup)
[![release](https://github.com/prologic/action-remark-lintworkflows/release/badge.svg)](https://github.com/prologic/action-remark-lintactions?query=workflow%3Arelease)
[![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/reviewdog/action-flake8?logo=github&sort=semver)](https://github.com/prologic/action-remark-lintreleases)
[![Test](https://github.com/reviewdog/action-remark-lint/workflows/Test/badge.svg)](https://github.com/reviewdog/action-remark-lint/actions?query=workflow%3ATest)
[![reviewdog](https://github.com/reviewdog/action-remark-lint/workflows/reviewdog/badge.svg)](https://github.com/reviewdog/action-remark-lint/actions?query=workflow%3Areviewdog)
[![depup](https://github.com/reviewdog/action-remark-lint/workflows/depup/badge.svg)](https://github.com/reviewdog/action-remark-lint/actions?query=workflow%3Adepup)
[![release](https://github.com/reviewdog/action-remark-lint/workflows/release/badge.svg)](https://github.com/reviewdog/action-remark-lint/actions?query=workflow%3Arelease)
[![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/reviewdog/action-flake8?logo=github&sort=semver)](https://github.com/reviewdog/action-remark-lint/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)
[![Linux CI](https://github.com/prologic/action-remark-lintworkflows/Linux%20CI/badge.svg)](https://github.com/prologic/action-remark-lintactions?query=workflow%3A%22Linux+CI%22)
[![MacOS CI](https://github.com/prologic/action-remark-lintworkflows/MacOS%20CI/badge.svg)](https://github.com/prologic/action-remark-lintactions?query=workflow%3A%22MacOS+CI%22)
[![Windows CI](https://github.com/prologic/action-remark-lintworkflows/Windows%20CI/badge.svg)](https://github.com/prologic/action-remark-lintactions?query=workflow%3A%22Windows+CI%22)

![action screenshot](https://user-images.githubusercontent.com/17570430/102060312-4ee5e000-3df2-11eb-8c82-767afeccd8db.png)
![action screenshot](https://user-images.githubusercontent.com/17570430/102059912-d3842e80-3df1-11eb-9b0a-2e04eab5e294.png)
Expand All @@ -28,7 +25,7 @@ jobs:
steps:
- uses: actions/checkout@v1
- name: remark-lint
uses: prologic/action-remark-lint@v0.0.5
uses: reviewdog/action-remark-lint/@v0.0.5
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
reporter: github-pr-check # Change reporter. (Only `github-pr-check` is supported at the moment).
Expand All @@ -52,23 +49,23 @@ See the Inputs section below for details on the defaults and optional configurat

### `level`

**Optional**. Report level for reviewdog [info,warning,error].
**Optional**. Report level for reviewdog \[info, warning, error\].
It's same as `-level` flag of reviewdog.

### `reporter`

**Optional**. Reporter of reviewdog command [github-pr-check,github-pr-review,github-check].
**Optional**. Reporter of reviewdog command \[github-pr-check, github-pr-review, github-check\].
Default is github-pr-check. github-pr-review can use Markdown and add a link to rule page in reviewdog reports.

**NB:** Only `github-pr-check` is supported currently.

#### `filter_mode`

**Optional**. Filtering mode for the reviewdog command [added, diff_context, file, nofilter]. Default = `"added"`.
**Optional**. Filtering mode for the reviewdog command \[added, diff_context, file, nofilter\]. Default = `"added"`.

#### `fail_on_error`

**Optional**. Exit code for reviewdog when errors are found [`true`, `false`]. Default = `false`.
**Optional**. Exit code for reviewdog when errors are found \[`true`, `false`\]. Default = `false`.

#### `reviewdog_flags`

Expand Down

0 comments on commit 8d4eb9c

Please sign in to comment.