Add example in README

This commit is contained in:
haya14busa
2020-01-19 08:30:27 +00:00
parent 2fbacc6d82
commit 6fcc3a18c7

View File

@@ -3,6 +3,29 @@
[![Test](https://github.com/haya14busa/action-depup/workflows/Test/badge.svg)](https://github.com/haya14busa/action-depup/actions?query=workflow%3ATest) [![Test](https://github.com/haya14busa/action-depup/workflows/Test/badge.svg)](https://github.com/haya14busa/action-depup/actions?query=workflow%3ATest)
[![reviewdog](https://github.com/haya14busa/action-depup/workflows/reviewdog/badge.svg)](https://github.com/haya14busa/action-depup/actions?query=workflow%3Areviewdog) [![reviewdog](https://github.com/haya14busa/action-depup/workflows/reviewdog/badge.svg)](https://github.com/haya14busa/action-depup/actions?query=workflow%3Areviewdog)
depup action updates version in a given file automatically.
**Supported patterns example:**
```
REVIEWDOG_VERSION=0.1.0
# v prefix is supported as well.
REVIEWDOG_VERSION=v0.1.0
```
```Dockerfile
# Dockerfile sample
ENV REVIEWDOG_VERSION=0.1.0
ENV REVIEWDOG_VERSION 0.1.0 # space is ok.
ARG REVIEWDOG_VERSION=0.1.0
```
```yaml
# yaml sample
yaml:
REVIEWDOG_VERSION: 0.1.0
```
## Inputs ## Inputs
```yaml ```yaml