Releases: stefanbuck/github-issue-parser
Releases · stefanbuck/github-issue-parser
v2.0.1
v2.0.0
2.0.0 (2021-09-13)
Bug Fixes
BREAKING CHANGES
- Before this change, IDs defined in a GitHub issue template that included a hyphen got converted to dashes for the Action output. This was mainly done to ensure nice-looking output variables. However, this is confusing as discussed in #15 (comment).
v1.0.4
v1.0.3
v1.0.2
v1.0.1
v1.0.0
GitHub Issue Parser
Use this action to convert issues into a unified JSON structure.
Setup
- uses: stefanbuck/github-issue-parser@main
id: issue-parser
with:
template-path: .github/ISSUE_TEMPLATE/bug-report.yml
- run: echo ${{ toJSON(steps.issue-parser.outputs.jsonString) }} > bug-details.json
template-path
is optional and meant to be used with Issue Forms.
Example
Given an issue form
name: Bug
description: Something is broken
title: "Order Pizza"
body:
- type: input
id: contact
attributes:
label: Your contact details
validations:
required: true
- type: input
id: what_happened
attributes:
label: What happened?
validations:
required: true
- type: input
id: version
attributes:
label: Version
validations:
required: true
- type: input
id: browsers
attributes:
label: What browsers are you seeing the problem on?
validations:
required: true
- type: checkboxes
attributes:
label: What else?
options:
- label: Never give up
- label: Hot Dog is a Sandwich
And an issue body
### Your contact details
[email protected]
### What happened?
A bug happened!
### Version
1.0.0
### What browsers are you seeing the problem on?
Chrome, Safari
### What else?
- [x] Never give up
- [ ] Hot Dog is a Sandwich
The actions output will be
{
"contact": "[email protected]",
"what_happened": "A bug happened!",
"version": "1.0.0",
"browsers": "Chrome, Safari",
"never_give_up": true,
"hot_dog_is_a_sandwich": false
}