docs: Add migration section

stefanbuck · Oct 19, 2022 · de423fc · de423fc
1 parent 0b27d4a
commit de423fc
Showing 1 changed file with 12 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -20,6 +20,18 @@ 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