From f527c20af2c945e55bb4902ec26e4509ffc204a6 Mon Sep 17 00:00:00 2001
From: Peter Ling <pling@scottlogic.com>
Date: Wed, 22 Nov 2023 13:46:37 +0000
Subject: [PATCH] SLVUU-109: Define files for readme and add comment to result

---
 .github/workflows/generate-readme.sh  | 4 ++++
 .github/workflows/generate-readme.yml | 3 +--
 docs/readme_contents.txt              | 3 +++
 3 files changed, 8 insertions(+), 2 deletions(-)
 create mode 100644 .github/workflows/generate-readme.sh
 create mode 100644 docs/readme_contents.txt

diff --git a/.github/workflows/generate-readme.sh b/.github/workflows/generate-readme.sh
new file mode 100644
index 000000000..d6a69d228
--- /dev/null
+++ b/.github/workflows/generate-readme.sh
@@ -0,0 +1,4 @@
+#!/bin/sh
+
+printf '[//]: # (This file is auto-generated by GitHub Actions. Please do not edit manually.\n\n)' > README_AUTO.md
+{ xargs cat < ./docs/readme_contents.txt ; } >> README_AUTO.md
diff --git a/.github/workflows/generate-readme.yml b/.github/workflows/generate-readme.yml
index af45ac172..155dfbdf9 100644
--- a/.github/workflows/generate-readme.yml
+++ b/.github/workflows/generate-readme.yml
@@ -8,9 +8,8 @@ jobs:
     steps:
       - name: Checkout
         uses: actions/checkout@v3
-      # TODO: check if source docs have been changed
       - name: Generate readme
-        run: cat docs/**/*.md > README_AUTO.md
+        run: generate-readme.sh
       - name: Commit
         uses: EndBug/add-and-commit@v9
         with:
diff --git a/docs/readme_contents.txt b/docs/readme_contents.txt
new file mode 100644
index 000000000..8365d51a2
--- /dev/null
+++ b/docs/readme_contents.txt
@@ -0,0 +1,3 @@
+./docs/faq/a_new_file.md
+./docs/faq/debugging_json_messages.md
+./docs/faq/faq.md