]> git.ipfire.org Git - thirdparty/zstd.git/commitdiff
add CI check for zstd_manual before release
authorYann Collet <cyan@fb.com>
Thu, 20 Feb 2025 19:46:14 +0000 (11:46 -0800)
committerYann Collet <cyan@fb.com>
Thu, 20 Feb 2025 21:00:16 +0000 (13:00 -0800)
ensures it's properly updated

.github/workflows/dev-short-tests.yml
.github/workflows/release_check.yml [new file with mode: 0644]

index 7df105532f0885a9146f7d122136d8413fff52dd..38a3a0f925e5ec6420bb648d51d3020ac1f9b97f 100644 (file)
@@ -41,7 +41,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # tag=v4.1.1
-    - name: ensure zstd can be build with c89/c90 compilers (+ long long support + variadic macros)
+    - name: ensure zstd can be built with c89/c90 compilers (+ long long support + variadic macros)
       run: |
         make c89build V=1
 
diff --git a/.github/workflows/release_check.yml b/.github/workflows/release_check.yml
new file mode 100644 (file)
index 0000000..aa1e817
--- /dev/null
@@ -0,0 +1,31 @@
+name: check_manual
+
+on:
+  push:
+    branches:
+      - release
+  pull_request:
+    branches:
+      - release
+
+permissions: read-all
+
+jobs:
+  verify-manual:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@v3
+
+      - name: Save current manual
+        run: mv doc/zstd_manual.html doc/zstd_manual_saved.html
+
+      - name: Generate new manual
+        run: make manual
+
+      - name: Compare manuals
+        run: |
+          if ! cmp -s doc/zstd_manual.html doc/zstd_manual_saved.html; then
+            echo "The manual was not updated before release !"
+            exit 1
+          fi