action.yml

name: 'Link issue'
description: 'Link a pull-request to an external issue getting id from branch name, PR title or commit message'
author: 'ov7a'

inputs:

  sources:
    required: false
    description: 'A list of locations where issue id should be taken from. Possible values: branch, title, commit.'
    default: |
      branch
      title
      commit

  issue-pattern:
    required: true
    description: 'A regex to match and extract issue id. For example, use "[A-Z][A-Z]+-\d+" for JIRA issues or "#(\d+)" for Redmine issues.'  

  link-template:
    required: true
    description: 'Link template to paste id or its part into. You should use regex groups here. Example: "https://example.com/browse/issues/$0"'    

  link-name-template:
    required: false    
    description: 'Template for link name'
    default: '$0'

  link-preamble:
    required: false    
    description: 'Text before list of links'
    default: 'Related issues: '

  link-location:
    required: false    
    description: 'Location to paste link to. Possible values: start, end.'
    default: 'end'

  token:
    required: true
    description: 'The GitHub authentication token'
    default: ${{ github.token }}

runs:
  using: 'node16'
  main: 'dist/index.js'

branding:
  icon: 'link'
  color: 'blue'