From 6fcc3a18c76b907b460b4442d37e3b7de2a7adc8 Mon Sep 17 00:00:00 2001 From: haya14busa Date: Sun, 19 Jan 2020 08:30:27 +0000 Subject: [PATCH] Add example in README --- README.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/README.md b/README.md index 4e22b5c..49451f8 100644 --- a/README.md +++ b/README.md @@ -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) [![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 ```yaml