ci: add help check

Author: alex-courtis

.github/workflows/ci.yml

@@ -62,6 +62,10 @@ jobs:
         mkdir -p luals
         curl -L "https://github.com/LuaLS/lua-language-server/releases/download/${LUALS_VERSION}/lua-language-server-${LUALS_VERSION}-linux-x64.tar.gz" | tar zx --directory luals
 
-    - name: check
+    - name: language server
       run: |
         VIMRUNTIME=/home/runner/nvim-${NVIM_VERSION}/share/nvim/runtime PATH="luals/bin:${PATH}" make check
+
+    - name: help
+      run: |
+        make check-help

CONTRIBUTING.md

@@ -65,7 +65,7 @@ VIMRUNTIME="/my/path/to/runtime" make check
 
 To add a new action, add a file in `actions/name-of-the-action.lua`. You should export a `setup` function if some configuration is needed.
 
-Once you did, you should run `make update-help`
+Once you did, you should run `make help-update`
 
 # Documentation
 

Makefile

@@ -22,8 +22,15 @@ style-fix:
 #
 # utility
 #
-update-help:
-	scripts/update-help.sh
+help-update:
+	scripts/help-update.sh
 
-.PHONY: all style lint check style-fix update-help
+#
+# CI
+#
+help-check:
+	scripts/help-update.sh
+	git diff --exit-code doc/nvim-tree-lua.txt
+
+.PHONY: all style lint check style-fix help-check help-update
 

scripts/update-help.sh renamed to scripts/help-update.sh

@@ -2,7 +2,7 @@
 
 # run after changing nvim-tree.lua DEFAULT_OPTS or keymap.lua M.default_on_attach
 # scrapes and updates nvim-tree-lua.txt
-# run from repository root: scripts/update-help.sh
+# run from repository root: scripts/help-update.sh  OR  make help-update
 
 
 #