Updated scripts to allow for stable flags

Author: webdevred

.github/script_helpers/extract_flags.awk

@@ -1,4 +1,53 @@
-/^flag / { flag=$2; in_desc=0 }
-/^ *description:/ { in_desc=1; if ($0 ~ /\(experimental\)/) print flag; next }
-in_desc && /^[[:space:]]+/ { if ($0 ~ /\(experimental\)/) print flag; next }
-/^[^[:space:]]/ { in_desc=0 }
+# Purpose:
+# - If EXPERIMENTAL_ONLY is non-empty -> print flags that contain "(experimental)"
+# - If EXPERIMENTAL_ONLY is empty     -> print flags that contain NO parentheses at all
+
+# state variables:
+# flag         - current flag name
+# in_desc      - 1 when inside a description block
+# experimental - 1 if any desc line contains "(experimental)"
+# has_parens   - 1 if any desc line contains any "(...)"
+
+
+/^flag[[:space:]]+/ {
+    # finalize previous flag (if any) before starting a new one
+    if (flag != "") {
+        if (EXPERIMENTAL_ONLY != "" && experimental)      print flag
+        else if (EXPERIMENTAL_ONLY == "" && !has_parens) print flag
+    }
+
+    # start new flag
+    flag = $2
+    in_desc = 0
+    experimental = 0
+    has_parens = 0
+    next
+}
+
+/^ *description:/ {
+    # enter description; check this line for parentheses
+    in_desc = 1
+    if ($0 ~ /\(experimental\)/) experimental = 1
+    if ($0 ~ /\([^)]+\)/)        has_parens = 1
+    next
+}
+
+in_desc && /^[[:space:]]+/ {
+    # indented description continuation lines
+    if ($0 ~ /\(experimental\)/) experimental = 1
+    if ($0 ~ /\([^)]+\)/)        has_parens = 1
+    next
+}
+
+/^[^[:space:]]/ {
+    # non-indented line ends any description block
+    in_desc = 0
+}
+
+END {
+    # finalize last flag at EOF
+    if (flag != "") {
+        if (EXPERIMENTAL_ONLY != "" && experimental)      print flag
+        else if (EXPERIMENTAL_ONLY == "" && !has_parens) print flag
+    }
+}

.github/scripts/add_experimental_flags.sh

@@ -17,15 +17,20 @@ fi
 
 MATRIX_JSON=$(sed -E 's/^matrix=//' <"$MATRIX_FILE")
 
-readarray -t EXP_FLAGS < <(awk -f ./.github/script_helpers/extract_flags.awk "$CABAL_FILE")
+readarray -t STABLE_FLAGS < <(awk -f ./.github/script_helpers/extract_flags.awk "$CABAL_FILE")
+readarray -t EXP_FLAGS < <(awk -v EXPERIMENTAL_ONLY=1 -f ./.github/script_helpers/extract_flags.awk "$CABAL_FILE")
 
-ORIGINAL=$(jq --arg label "stable" '.include[0] += {label: $label}' <<<"$MATRIX_JSON")
+STABLE_FLAGS_STRING=""
+if ! [[ ${#STABLE_FLAGS[@]} -eq 0 ]]; then
+  STABLE_FLAGS_STRING=$(printf '+%s ' "${STABLE_FLAGS[@]}")
+fi
+ORIGINAL=$(jq --arg flags "$STABLE_FLAGS_STRING" --arg label "stable" '.include[0] += {flags: $flags, label: $label}' <<<"$MATRIX_JSON")
 
 if [[ ${#EXP_FLAGS[@]} -eq 0 ]]; then
   UPDATED="$ORIGINAL"
 else
   EXP_FLAGS_STRING=$(printf '+%s ' "${EXP_FLAGS[@]}")
-  EXPERIMENTAL=$(jq --arg flags "$EXP_FLAGS_STRING" --arg label "experimental" \
+  EXPERIMENTAL=$(jq --arg flags "$STABLE_FLAGS_STRING $EXP_FLAGS_STRING" --arg label "experimental" \
     '.include[0] += {flags: $flags, label: $label}' <<<"$MATRIX_JSON")
 
   UPDATED=$(jq --argjson exp_include "$(jq '.include' <<<"$EXPERIMENTAL")" \

.github/scripts/configure_project.sh

@@ -2,19 +2,10 @@
 
 set -euo pipefail
 
-IS_EXPERIMENTAL=0
-
 cabal configure --project-file cabal.project.release -O1
 
-if [[ "$LABEL" == "" ]]; then
-  echo "LABEL must be set"
-elif [[ "$LABEL" == "experimental" ]]; then
-  IS_EXPERIMENTAL=1
-fi
-
-echo "package jbeam-edit" >>cabal.project.release.local
-echo "  tests: True" >>cabal.project.release.local
-if [[ $IS_EXPERIMENTAL -eq 1 ]]; then
+printf "package jbeam-edit\n  tests: True\n" >>cabal.project.release.local
+if ! [[ "$MATRIX_FLAGS" == "" ]]; then
   echo "  flags: $MATRIX_FLAGS" >>cabal.project.release.local
 fi
 

jbeam-edit.cabal

@@ -45,7 +45,7 @@ source-repository head
     location: https://github.com/webdevred/jbeam-edit
 
 flag dump-ast
-    description: Enable building the dump-ast executable
+    description: Enable building the dump-ast executable (dev-only)
     default:     False
     manual:      True
 
@@ -61,7 +61,7 @@ flag transformation
 
 flag windows-example-paths
     description:
-        Use executable-relative example paths (for Windows release builds)
+        Use executable-relative example paths (windows-installer-only)
 
     default:     False
     manual:      True

package.yaml

@@ -54,7 +54,7 @@ ghc-options:
 
 flags:
   dump-ast:
-    description: Enable building the dump-ast executable
+    description: Enable building the dump-ast executable (dev-only)
     manual: true
     default: false
   transformation:
@@ -66,7 +66,7 @@ flags:
     manual: true
     default: false
   windows-example-paths:
-    description: Use executable-relative example paths (for Windows release builds)
+    description: Use executable-relative example paths (windows-installer-only)
     default: false
     manual: true