Default to template field ID for parsed issue body key#73
Merged
Conversation
By default, when an issue body is parsed, the action will now attempt to match the header in the issue body markdown with the label field of the issue template. If found, it will check if an ID is present for that field. If present, the ID will be used for the property key. Otherwise, the action reverts to the original behavior (slugifying the field label).
E.g. If the field looks like this in the template:
```yaml
- type: input
id: name
attributes:
label: The Name of the Thing
description: The name of the thing you want to create.
placeholder: this-is-the-thing
validations:
required: true
```
Then the parsed issue body will loo like this:
```json
{
"name": "Whatever the user-provided value is"
}
```
Otherwise, if the field looks like this in the template
```yaml
- type: input
attributes:
label: The Name of the Thing
description: The name of the thing you want to create.
placeholder: this-is-the-thing
validations:
required: true
```
Then the parsed issue body JSON will look like:
```json
{
"the_name_of_the_thing": "Whatever the user-provided value is"
}
```
🦙 MegaLinter status: ✅ SUCCESS
See detailed report in MegaLinter reports |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
By default, when an issue body is parsed, the action will now attempt to match the header in the issue body markdown with the label field of the issue template. If found, it will check if an ID is present for that field. If present, the ID will be used for the property key. Otherwise, the action reverts to the original behavior (slugifying the field label).
E.g. If the field looks like this in the template:
Then the parsed issue body will loo like this:
{ "name": "Whatever the user-provided value is" }Otherwise, if the field looks like this in the template
Then the parsed issue body JSON will look like:
{ "the_name_of_the_thing": "Whatever the user-provided value is" }