From 6fcc3a18c76b907b460b4442d37e3b7de2a7adc8 Mon Sep 17 00:00:00 2001 From: haya14busa Date: Sun, 19 Jan 2020 08:30:27 +0000 Subject: [PATCH 1/3] 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 From 09744e1b2506cb5910f1039e716b1f1d21005a46 Mon Sep 17 00:00:00 2001 From: haya14busa Date: Sun, 19 Jan 2020 08:32:14 +0000 Subject: [PATCH 2/3] Add demo in README --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index 49451f8..b1a46f4 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,8 @@ 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:** ``` @@ -26,6 +28,8 @@ yaml: REVIEWDOG_VERSION: 0.1.0 ``` +demo: https://github.com/haya14busa/action-depup/pull/4 + ## Inputs ```yaml From adcb4ba2b4c55d987231ddd1cb977a589e11fca1 Mon Sep 17 00:00:00 2001 From: haya14busa Date: Sun, 19 Jan 2020 08:33:40 +0000 Subject: [PATCH 3/3] tweak --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index b1a46f4..3eb1684 100644 --- a/README.md +++ b/README.md @@ -18,7 +18,8 @@ REVIEWDOG_VERSION=v0.1.0 ```Dockerfile # Dockerfile sample ENV REVIEWDOG_VERSION=0.1.0 -ENV REVIEWDOG_VERSION 0.1.0 # space is ok. +# space is supported as well. +ENV REVIEWDOG_VERSION 0.1.0 ARG REVIEWDOG_VERSION=0.1.0 ```