Issue Template Parser 📜

A GitHub Action to convert issues created from issue templates into machine readable JSON for further processing

About 💡

This action is designed to be used in conjunction with issue forms to allow you to parse created issues into machine-readable JSON for processing.

Issues submitted using issue forms use a structured Markdown format. So long as the issue body is not heavily modified by the user, we can reliably parse the issue body into a JSON object.

You can use this action to conditionally run steps in a workflow based on the contents of the issue body. For example, you may want to run a step only if the issue body contains a specific keyword, version number, etc.

Setup ⚙️

Here is a simple example of how to use this action in your workflow. Make sure to replace vX.X.X with the latest version of this action.

steps:
  - name: Parse Issue
    id: parse-issue
    uses: GrantBirki/issue-template-parser@vX.X.X
    with:
      body: ${{ github.event.issue.body }}

  - name: Output Issue JSON
    id: output-issue
    run: echo ${{ steps.issue-parser.outputs.json }}

Look below in this README for a full workflow example

Inputs 📥

Input	Default	Description
`body`	`${{ github.event.issue.body }}`	The issue body to parse
`csv_to_list`	`true`	Convert single-line responses with commas to lists

Outputs 📤

Output	Description
`json`	The parsed issue as a JSON string

Example 📸

Given the following issue body:

### Your contact details

me@me.com

### 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 output of this action would be:

{
  "your_contact_details": "me@me.com",
  "what_happened": "A bug happened!",
  "version": "1.0.0",
  "what_browsers_are_you_seeing_the_problem_on": ["Chrome", "Safari"],
  "code_of_conduct": {
    "selected": ["Never give up"],
    "unselected": ["Hot Dog is a Sandwich"]
  }
}

Transformations

Headings

The following transformations will take place for each heading:

Transformation	Before	After
Trim	`### This is a title! :)`	`This is a title! :)`
Lowercase	`This is a title! :)`	`this is a title! :)`
Replace Spaces	`this is a title! :)`	`this_is__a_title!_:)`
Remove Symbols	`this_is_a_title!_:)`	`this_is__a_title_`
Dedupe Underscores	`this_is__a_title_`	`this_is_a_title`

Values

The following transformations will take place for responses, depending on the type/format.

Single Line

Before:

This is a response, it has commas, and is awesome

When csv_to_list is 'true':

["This is a response", "it has commas", "and is awesome"]

When csv_to_list is 'false', the value will not change:

This is a response, it has commas, and is awesome

Multiline

Note

Empty lines are preserved in multiline responses.

Before:

First line :D

Third line!

After:

First line :D\n\nThird line!

Checkboxes

Before:

- [x] Pick me!
- [ ] Don't pick me D:

After:

{
  "selected": ["Pick me!"],
  "unselected": ["Don't pick me D:"]
}

Omitting Inputs

In the following situations, an input will be omitted from the output JSON:

Scenario	Example
Invalid Heading	`## This is invalid`
Empty Heading	`###`
	`This is a value`
No Value	`### This is a heading`
	`<empty>`
	`### This is another`
	`This is a value`

Full Workflow Example 🚀

Here is a full workflow example that will run on any issue that is opened or edited. It will parse the issue body into JSON and then print the JSON to the console.

You may want to add some extra conditional logic to this workflow to only run on the specific issues you want to parse. For example, if you have a bug report issue template, you may want to only run this workflow on issues that have the "bug report" label. This will help to prevent unnecessary workflow runs or workflow failures that aren't related to the issue template parsing.

name: Example Workflow

on:
  issues:
    types:
      - opened
      - edited

permissions:
  issues: read

jobs:
  example:
    name: Example Job
    runs-on: ubuntu-latest

    steps:
      # Replace vX.X.X the latest version
      - name: Parse Issue
        id: parse-issue
        uses: GrantBirki/issue-template-parser@vX.X.X
        with:
          body: ${{ github.event.issue.body }}

      - name: Output Issue JSON
        id: output-issue
        run: echo ${{ steps.issue-parser.outputs.json }}

Releasing a New Version 🏷️

To release a new version run script/release and then publish the following release.