Get-IssueFormData

Reads the body of an issue and parses it into a JSON object.

Bases itself on the definitions of GitHub Issue Forms:

• Syntax for issue forms | GitHub Docs
• Syntax for GitHub's form schema

Usage

Provided the following issue body:

### Name

Name provided in the issue.

### Language

PowerShell

### Rationale

I need the
<!-- This is
a comment --> data parsed

### OS

- [ ] macOS
- [x] Ubuntu
- [x] Windows

This action returns the following JSON object:

{
    "Name": "Name provided in the issue.",  // input
    "Language": "PowerShell",               // dropdown
    "Rationale": "I need the\ndata parsed", // textarea
    "OS": {                          // checkbox
        "macOS": false,
        "Ubuntu": true,
        "Windows": true
    }
}

Inputs

Name	Description	Default	Required
IssueBody	The body of the issue, if not provided it will use the body of the issue that triggered the workflow.	${{ github.event.issue.body }}	false

Outputs

Name	Description
data	The parsed JSON object

Example

name: Example workflow
on:
  issues:
    types:
      - opened
      - edited

permissions:
  contents: read

jobs:
  assign:
    name: Process issue
    runs-on: ubuntu-latest
    steps:
      - name: Get-IssueFormData
        id: Get-IssueFormData
        uses: PSModule/Get-IssueFormData@v1

      - name: Print data
        shell: pwsh
        env:
          data: ${{ steps.Get-IssueFormData.outputs.data }}
        run: |
          $data = $env:data | ConvertFrom-Json
          Write-Output $data

Alternatives

• github/issue-parser
• issue-ops/parser
• peter-murray/issue-forms-body-parser
• peter-murray/issue-body-parser-action