action-docs icon indicating copy to clipboard operation
action-docs copied to clipboard

pipe `|` is not properly escaped

Open npalm opened this issue 11 months ago • 1 comments

Having | symbols in input or output description is breaking the table creation due to the lack of a proper escape.

npalm avatar Mar 14 '24 17:03 npalm

Hello Niek, I'm currently having trouble with this. Although I found a workaround for my work setup, it would be nice to have this fixed. In my action I have this input:

inputs:
  branch:
    description: 'Branch'
    required: false
    default: ${{ github.base_ref || github.ref_name  }}

The problem is that I cannot change that default value. The result is this:

| `branch` | <p>Branch</p> | `false` | `${{ github.base_ref || github.ref_name  }}` |

image

Just to remember we also have this section (wich is good): image

Solution

The script could replace | to \|, only when creating the table, at least at the default parameters.

Thank you.

Gonzalo44r avatar May 24 '24 06:05 Gonzalo44r