GitHub Action
Issue Form Body Parser
GitHub Action that will parse the issue body that has been generated from an Issue Form Template.
The purpose of this action is to take the collected input from the user (ideally nothing overly free form to make it difficult to parse) and return the parsed results into a JSON encoded object.
To achieve this, we need to define a separator and some markers for the opening/closing of the label for the value provided by the user.
Currently as of writing this, the Issue form templates will use the h3 header ###
in the markdown as the separator.
It is then up to the person defining the labels to use a consistent open/close marker for all the form entries being collected from the user in the Issue Template.
So in this example if I was to use >>
and <<
characters to enclose the labels for the various inputs/fields in the template, we can later parse the generated issue body that would be created:
### >>demo-repository-owner<<
octodemo
### >>demo-repository-name<<
pm-automation-test-001
### >>template<<
octodemo/template-demo-github-user-search
Input | Required | Description |
---|---|---|
github_token |
true |
PAT(Personal Access Token) for accessing the issues on the repository, defaults to ${{ github.token }} . |
repository |
true |
The fully qualified repository that has the issue, defaults to ${{ github.repository }} . |
issue_id |
true |
The id of the issue to load the content from. |
separator |
false |
The separator between the fields defaults to ### which is markdown h3 which GitHub is currently defaulting to |
label_marker_start |
true |
The characters to match for the beginning of a label |
label_marker_end |
true |
The characters to match for the ending of a label |
generate_summary |
false |
Generate an actions summary with the parsed data, optional and defaults to false |
If you have checkboxes rendered in the template, this action will provide them as an object of the name of the checkbox label associated with a true
or false
value.
e.g.
### >>Languages<<
- [X] English
- [X] French
- [ ] German
would result in a JSON object that looks like this;
{
"Languages": {
"English": true,
"French": true,
"German": false
}
}
Usage to parse the message example above:
steps:
- name: Run Issue form parser
id: parse
uses: peter-murray/issue-forms-body-parser@v4.0.0
with:
issue_id: ${{ github.event.issue.number }}
separator: '###'
label_marker_start: '>>'
label_marker_end: '<<'
- name: Show parsed data JSON
env:
parsed_data: ${{ steps.parse.outputs.payload }}
run: |
echo "$parsed_data"
The JSON payload that is extracted would look like this:
{
"demo-repository-owner":"octodemo",
"demo-repository-name":"pm-automation-test-001",
"template":"octodemo/template-demo-github-user-search"
}