action.yml

name: 'Ref to Version'
description: 'Uses the ref to extract a version'

inputs:
  versionFile:
    description: >
      Specify a path to a json file that has a top level 'version'
      property, i.e. package.json. The value of that version will be 
      used as a prefix for the output, using '-' as a separator
    required: false
  useVersionFile:
    description: >
      Configure if and when a version file should be considered. This takes
      a comma separated list. The permitted values are 'branch', 'pr', 'tag'.
    required: false
    default: 'branch,pr'
  createRunVersion:
    description: >
      Configure if and when a unique run version should be created using
      github.run_number and github.run_attempt. The permitted values are 'branch', 'pr', 'tag'.
    required: false
    default: 'branch,pr'
  versionFileSeparator:
    description: Separator used when concatenating the ref and version file versions
    required: false
    default: '-'
  from-tag:
    description: >
      Pass a tag name and set the output version using the same logic as if it
      would have been a ref tag.
    required: false
  tagPrefix:
    description: >
      A prefix that will be removed from the beginning of the tag name
      to compute the version name.
    default: 'v'
    required: false

outputs:
  version:
    description: >
      The version extracted from the github ref
  isTag:
    description: Boolean that indicates that a tag version was created
  isPullRequest:
    description: Boolean that indicates that a Pull Request version was created
  isBranch:
    description: Boolean that indicates that a branch version was created

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