This is a Github action, highly infuenced from https://github.com/peter-murray/issue-body-parser-action. The main use case is for this action to be triggered by a Github issue comment in order to parse a JSON or YAML payload from it.

Required The Github token to use for getting the issue comment via the API.

Required The id of the issue comment that will be parsed.

Required The format of the payload we expect to be parsing from the comment. Defaults to json

Required The optional marker for the YAML or JSON payload to parse, in case the comment contains multiple. Defaults to "".

The data that was parsed from the JSON or YAML payload as a string. It can be easily converted to JSON using the fromJSON expression

on:
  issue_comment:
    types: [created]
    
jobs:
  do_something:
    name: A job that does something
    runs-on: ubuntu-latest
    steps:
      - name: Parse comment 
        id: parse
        uses: actions/[email protected]
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          comment_id: ${{ github.event.comment.id }}
          format: yaml
      - name: Echo the output
        run: echo ${{ steps.parse.outputs.content }} 
      - name: Use the output as JSON
        run: echo ${{ fromJson(steps.parse.outputs.content).some_key }}