Add a check in the CI to keep the readme up to date

1 files changed, 18 insertions, 0 deletions

diff --git a/.github/workflows/documentation.yaml b/.github/workflows/documentation.yaml
new file mode 100644
index 0000000..91f611f
--- /dev/null
+++ b/.github/workflows/documentation.yaml
@@ -0,0 +1,18 @@
+name: Check that the README is up to date
+
+on:
+  pull_request:
+  push:
+
+jobs:
+  latest:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checking out the code
+        uses: actions/checkout@v3
+      - run: |
+          for function in $(find include/ -type f -exec sed -n 's/^_FORTIFY_FN(\([^)]\+\)).*/\1/p' '{}' ';' | sort | uniq)
+          do
+                grep "\`$function\`" README.md || (echo "Please add \`$function\` to the README.md file." && exit 1)
+          done
+