From fc998062d100e9b208bec07f67a19abdfbd0ac58 Mon Sep 17 00:00:00 2001 From: Josh Johanning Date: Wed, 19 Oct 2022 18:04:57 -0500 Subject: [PATCH 1/4] feat: add issue-body default closes https://github.com/stefanbuck/github-issue-parser/issues/46 --- action.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/action.yml b/action.yml index ca6ee6f..7d8dcd0 100644 --- a/action.yml +++ b/action.yml @@ -9,6 +9,7 @@ inputs: issue-body: required: true description: 'Issue body to parse' + default: ${{ github.event.issue.body }} outputs: jsonString: description: 'JSON string' From 50bb37045b3f90d2f65177fd98915823f2a6e395 Mon Sep 17 00:00:00 2001 From: Josh Johanning Date: Thu, 20 Oct 2022 08:00:00 -0500 Subject: [PATCH 2/4] doc: updating issue-body references closes https://github.com/stefanbuck/github-issue-parser/issues/46 --- README.md | 14 +------------- 1 file changed, 1 insertion(+), 13 deletions(-) diff --git a/README.md b/README.md index ebf9993..d53dc29 100644 --- a/README.md +++ b/README.md @@ -10,8 +10,8 @@ Use this action to convert issues into a unified JSON structure. Read the [Codel - uses: stefanbuck/github-issue-parser@v3 id: issue-parser with: - issue-body: ${{ github.event.issue.body }} # required template-path: .github/ISSUE_TEMPLATE/bug-report.yml # optional but recommended + issue-body: ${{ github.event.issue.body }} # default value, can be omitted - run: cat ${HOME}/issue-parser-result.json @@ -20,18 +20,6 @@ Use this action to convert issues into a unified JSON structure. Read the [Codel FAVORITE_DISH: ${{ steps.issue-parser.outputs.issueparser_favorite_dish }} ``` -## Migrate from v2 to v3 - -```diff --- uses: stefanbuck/github-issue-parser@v2 -+- uses: stefanbuck/github-issue-parser@v3 - id: issue-parser - with: -+ issue-body: ${{ github.event.issue.body }} - template-path: .github/ISSUE_TEMPLATE/bug-report.yml -``` - - ## Example Given an issue form From 6341f6b4599f77854efdb4a1c79be5302d2487eb Mon Sep 17 00:00:00 2001 From: Josh Johanning Date: Thu, 20 Oct 2022 13:19:02 -0500 Subject: [PATCH 3/4] doc: removing issue-body from default usage MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Hervé Le Meur <91831478+lemeurherve@users.noreply.github.com> --- README.md | 1 - 1 file changed, 1 deletion(-) diff --git a/README.md b/README.md index d53dc29..19cb8f4 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,6 @@ Use this action to convert issues into a unified JSON structure. Read the [Codel id: issue-parser with: template-path: .github/ISSUE_TEMPLATE/bug-report.yml # optional but recommended - issue-body: ${{ github.event.issue.body }} # default value, can be omitted - run: cat ${HOME}/issue-parser-result.json From c59d9fdf679a77881893a945799f1bdf4e513b60 Mon Sep 17 00:00:00 2001 From: Josh Johanning Date: Thu, 20 Oct 2022 13:29:28 -0500 Subject: [PATCH 4/4] doc: adding note about issue-body --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 19cb8f4..b66853c 100644 --- a/README.md +++ b/README.md @@ -19,6 +19,8 @@ Use this action to convert issues into a unified JSON structure. Read the [Codel FAVORITE_DISH: ${{ steps.issue-parser.outputs.issueparser_favorite_dish }} ``` +The text to be parsed can be set explicitly using `issue-body` input, otherwise it can be left to use the default value of `${{ github.event.issue.body }}`. + ## Example Given an issue form