diff --git a/README.md b/README.md index 4e22b5c..3eb1684 100644 --- a/README.md +++ b/README.md @@ -3,6 +3,34 @@ [![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) +depup action updates version in a given file automatically. + +[![demo](https://user-images.githubusercontent.com/3797062/72677595-7ac4ec80-3ae1-11ea-8b49-163bb72f822c.png)](https://github.com/haya14busa/action-depup/pull/4) + +**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 +# space is supported as well. +ENV REVIEWDOG_VERSION 0.1.0 +ARG REVIEWDOG_VERSION=0.1.0 +``` + +```yaml +# yaml sample +yaml: + REVIEWDOG_VERSION: 0.1.0 +``` + +demo: https://github.com/haya14busa/action-depup/pull/4 + ## Inputs ```yaml