Skip to content

Commit

Permalink
Add README
Browse files Browse the repository at this point in the history
  • Loading branch information
haya14busa committed Aug 8, 2020
1 parent 23fef63 commit 877cd06
Showing 1 changed file with 44 additions and 0 deletions.
44 changes: 44 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
# reviewdog/action-setup

[![Test](https://github.com/reviewdog/action-setup/workflows/Test/badge.svg)](https://github.com/reviewdog/action-setup/actions?query=workflow%3ATest)
[![reviewdog](https://github.com/reviewdog/action-setup/workflows/reviewdog/badge.svg)](https://github.com/reviewdog/action-setup/actions?query=workflow%3Areviewdog)
[![release](https://github.com/reviewdog/action-setup/workflows/release/badge.svg)](https://github.com/reviewdog/action-setup/actions?query=workflow%3Arelease)
[![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/reviewdog/action-setup?logo=github&sort=semver)](https://github.com/reviewdog/action-setup/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 installs [reviewdog](https://github.com/reviewdog/reviewdog).

## Input
```yaml
inputs:
reviewdog_version:
description: 'reviewdog version. [latest,nightly,vX.Y.Z]'
default: 'latest'
```
## Usage
### Latest
```yaml
steps:
- uses: reviewdog/action-setup@v1
- run: reviewdog -version
```
### Specify reviewdog version
```yaml
steps:
- uses: reviewdog/action-setup@v1
with:
reviewdog_version: v0.10.1
- run: reviewdog -version
```
### Nightly
```yaml
steps:
- uses: reviewdog/action-setup@v1
with:
reviewdog_version: nightly
- run: reviewdog -version
```

0 comments on commit 877cd06

Please sign in to comment.