[#10] Add support for filtering spec items using OFT tags

The OFT Action has been extended to support a new input parameter
for specifying tag values which are passed on to the run-oft.sh script.

Author: sophokles73

Dockerfile

@@ -13,6 +13,6 @@ wget -P $LIB_DIR ${base_url}/openfasttrace/releases/download/$OFT_CORE_VERSION/o
 wget -P $LIB_DIR ${base_url}/openfasttrace-asciidoc-plugin/releases/download/$OFT_ASCIIDOC_PLUGIN_VERSION/openfasttrace-asciidoc-plugin-$OFT_ASCIIDOC_PLUGIN_VERSION-with-dependencies.jar
 EOF
 
-COPY run-oft.sh /opt/oft/run-oft.sh 
+COPY run-oft.sh /opt/oft/run-oft.sh
 
 ENTRYPOINT [ "/opt/oft/run-oft.sh" ]

action.yaml

@@ -20,6 +20,10 @@ inputs:
     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.
@@ -35,8 +39,3 @@ outputs:
 runs:
   using: "docker"
   image: "Dockerfile"
-  args:
-    - ${{ inputs.fail-on-error }}
-    - ${{ inputs.report-filename }}
-    - ${{ inputs.report-format }}
-    - ${{ inputs.file-patterns }}

doc/spec/system_requirements.md

@@ -33,3 +33,13 @@ Covers:
 - feat~standard-github-action~1
 
 Needs: impl
+
+### Filter specification items based on tags
+`req~filter-specitems-using-tags~1`
+
+The OFT Action supports filtering relevant specification items using OFT Tags.
+
+Covers:
+- feat~standard-github-action~1
+
+Needs: impl

run-oft.sh

@@ -1,20 +1,24 @@
-#!/bin/sh
+#!/bin/bash
 
-# [impl->req~run-oft-trace-command~1]
-fail_on_error=$1
-report_file_name=$2
-report_format=$3
-files=$4
+fail_on_error=${INPUT_FAIL-ON-ERROR:-"false"}
+report_file_name=${INPUT_REPORT-FILE-NAME:-"trace-report.txt"}
+report_format=${INPUT_REPORT-FORMAT:-"plain"}
+tags=${INPUT_TAGS:-""}
+file_patterns=${INPUT_FILE-PATTERNS:-"."}
+
+options=(-o "$report_format" -f "$report_file_name")
+# [impl->req~filter-specitems-using-tags~1]
+if [[ -n "$tags" ]]; then
+  options=("${options[@]}" -t "$tags")
+fi
 
 echo "::notice::using OpenFastTrace JARs from: ${LIB_DIR}"
+echo "::notice::running OpenFastTrace for file patterns: $file_patterns"
 
-# Run OpenFastTrace
+# [impl->req~run-oft-trace-command~1]
 # shellcheck disable=SC2086
 # we need to provide the file patterns unquoted in order for the shell to expand any glob patterns like "*.md"
-if (java -cp "${LIB_DIR}/*" \
-  org.itsallcode.openfasttrace.core.cli.CliStarter trace -o "${report_format}" \
-  -f "${report_file_name}" \
-  ${files})
+if (java -cp "${LIB_DIR}/*" org.itsallcode.openfasttrace.core.cli.CliStarter trace "${options[@]}" $file_patterns)
 then
   echo "oft-exit-code=0" >> "${GITHUB_OUTPUT}"
   echo "All specification items are covered." >> "${GITHUB_STEP_SUMMARY}"