action.yaml

name: 'Generate pull request description'
description: "Dynamically generate the pull request description for a branch from its commit messages."
author: 'cortadocodes'
branding:
  icon: git-pull-request
  color: green
inputs:
  pull_request_url:
    description: 'The GitHub API URL for the pull request to generate the release notes from. This can be obtained from the GitHub actions environment.'
    required: true
  api_token:
    description: 'A GitHub API token. This can be obtained from the GitHub actions environment.'
    required: true
  header:
    description: 'The header (including MarkDown styling) to put the release notes under.'
    required: false
    default: '# Contents'
  list_item_symbol:
    description: 'The MarkDown list item symbol to use for listing commit messages in the release notes.'
    required: false
    default: '-'
outputs:
  pull_request_description:
    description: 'The generated pull request description.'

runs:
   using: 'docker'
   image: 'docker://octue/generate-pull-request-description:1.0.0.beta-2'
   args:
     - ${{ inputs.pull_request_url }}
     - ${{ inputs.api_token }}
     - ${{ inputs.header }}
     - ${{ inputs.list_item_symbol }}