action.yaml

# Perform requirements tracing against specification documents and source code using OpenFastTrace (https://github.com/itsallcode/openfasttrace)
# Returns the URL of the created HTML report as an output

# [impl->req~run-oft-trace-command~1]
name: "Run OpenFastTrace"
description: |
  Runs OpenFastTrace with the `trace` command on files in the local workspace.
inputs:
  file-patterns:
    description: |
      A whitespace separated list of (standard Bash) glob patterns which specify the files and directories to include in the OFT trace run.
      If not specified, the local workspace directory is used.
    default: "."
    required: false
  report-filename:
    description: |
      The name of the file that OpenFastTrace should write the analysis results to.
    required: true
  report-format:
    description: The format of the report that OpenFastTrace should produce.
    default: "plain"
    required: false
  tags:
    description: |
      A comma separated list of tags to use for filtering specification items.
    required: false
  fail-on-error:
    description: |
      By default, the action will never fail but indicate the result of running the trace command in the "oft-exit-code" output variable.
      Setting this parameter to "true" will let the Action return the exit code produced by running OpenFastTrace.
    default: "false"
    required: false
outputs:
  oft-exit-code:
    description: |
      The exit code indicating the outcome of running OpenFastTrace (0: success, > 0: failure).
      The report is created in any case, as long as OpenFastTrace could be run at all.

runs:
  using: "docker"
  image: "Dockerfile"
  env:
    OFT_FILE_PATTERNS: ${{ inputs.file-patterns }}
    OFT_REPORT_FORMAT: ${{ inputs.report-format }}
    OFT_REPORT_FILENAME: ${{ inputs.report-filename }}
    OFT_TAGS: ${{ inputs.tags }}
    OFT_FAIL_ON_ERROR: ${{ inputs.fail-on-error }}