Adding a warning message to README.md

USCbiostats · Oct 18, 2021 · 8e3b4f6 · 8e3b4f6
1 parent f367335
commit 8e3b4f6
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 0 deletions.
diff --git a/.github/workflows/build-readme.yml b/.github/workflows/build-readme.yml
@@ -30,6 +30,7 @@ jobs:
         run:  |
           docker run -v$(pwd):/home/report -w/home/report uscbiostats/software-dev:latest \
             Rscript -e 'rmarkdown::render("README.Rmd")'
+          ./docker/print_warning.sh
 
       - name: Commit results
         run: |

diff --git a/docker/print_warning.sh b/docker/print_warning.sh
@@ -0,0 +1,8 @@
+#!/bin/bash
+sed -i '1s/^/<!---\
+#########################################################################\
+#########################################################################\
+NOTE: DO NOT EDIT THE README.md BY HAND. ONLY EDIT THE README.Rmd BY HAND\
+#########################################################################\
+#########################################################################\
+--->/' README.md