From 7e7e55514b34feed689b0c4c527e9d36d2b16a56 Mon Sep 17 00:00:00 2001 From: c-bata Date: Wed, 29 Jan 2020 02:16:14 +0900 Subject: [PATCH] Add description for 'title' input --- README.md | 5 +++++ action.yml | 2 +- 2 files changed, 6 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index a67b8d6..da9d3f1 100644 --- a/README.md +++ b/README.md @@ -15,6 +15,10 @@ See [github-actions-kurobako/plot](./plot) action to generate a plot image. **Required** A public image url to kurobako plot image. +### `title` + +**Optional** A text for the title. + ## Outputs There is no output values. @@ -27,6 +31,7 @@ uses: c-bata/github-actions-kurobako@master with: report-md-path: './kurobako-report.md' public-image-url: 'https://example.com/public-image-url.png' + text: 'Benchmark of quadratic function' ``` ## License diff --git a/action.yml b/action.yml index fb9630a..42cb7bc 100644 --- a/action.yml +++ b/action.yml @@ -10,7 +10,7 @@ inputs: required: true default: 'https://storage.googleapis.com/kurobako-reports/dummy.png' title: - description: 'A title text for the top of header' + description: 'A text for the title' required: false default: 'Kurobako benchmark' outputs: