SLVUU-109: Define files for readme and add comment to result

ScottLogic · Nov 22, 2023 · f527c20 · f527c20
1 parent bdf5e6b
commit f527c20
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 2 deletions.
diff --git a/.github/workflows/generate-readme.sh 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
@@ -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
@@ -0,0 +1,3 @@
+./docs/faq/a_new_file.md
+./docs/faq/debugging_json_messages.md
+./docs/faq/faq.md