Skip to content

Releases: stefanbuck/github-issue-parser

v2.0.1

24 May 21:55
Compare
Choose a tag to compare

2.0.1 (2022-05-24)

Bug Fixes

  • Fix issue with path construction on windows #22 (fb73b92)

v2.0.0

13 Sep 22:06
6cfd00c
Compare
Choose a tag to compare

2.0.0 (2021-09-13)

Bug Fixes

  • Do not convert ids to dashes in output (#19) (6cfd00c)

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

12 Sep 21:25
Compare
Choose a tag to compare

1.0.4 (2021-09-12)

Bug Fixes

v1.0.3

12 Sep 21:02
Compare
Choose a tag to compare

1.0.3 (2021-09-12)

Bug Fixes

  • do not publish node_modules folder (4bf5102)

v1.0.2

12 Sep 21:00
44d26c5
Compare
Choose a tag to compare

1.0.2 (2021-09-12)

Bug Fixes

v1.0.1

12 Sep 20:51
e78326b
Compare
Choose a tag to compare

1.0.1 (2021-09-12)

Bug Fixes

v1.0.0

11 Sep 20:53
df077d6
Compare
Choose a tag to compare

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
}