From 36d7b9197c4863c9a0113512bb566a2ee0b5d72d Mon Sep 17 00:00:00 2001
From: jvoisin
Date: Fri, 8 Dec 2023 18:41:35 +0100
Subject: Add a check in the CI to keep the readme up to date

---
 .github/workflows/documentation.yaml | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)
 create mode 100644 .github/workflows/documentation.yaml

(limited to '.github/workflows')

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
+
-- 
cgit v1.3