build(ci): setup ci pipeline

Author: AnsonH

.github/workflows/main.yml

@@ -38,13 +38,27 @@ jobs:
         uses: rhysd/action-setup-vim@v1
         with:
           neovim: true
-          version: v0.11.0
+          version: stable
 
       - name: generate documentation
-        run: make documentation-ci
+        uses: kdheepak/panvimdoc@main
+        with:
+          vimdoc: copy-python-path
+          pandoc: README.md
+          version: Neovim >= 0.7.0
+          demojify: true
+
+      - name: generate tags
+        run: |
+          nvim --headless -c 'helptags doc' -c 'quit'
 
-      - name: check docs diff
-        run: exit $(git status --porcelain doc | wc -l | tr -d " ")
+      - name: push changes
+        uses: stefanzweifel/git-auto-commit-action@v6
+        with:
+          commit_message: "docs(vimdoc): auto-generate vimdocs"
+          commit_user_name: "github-actions[bot]"
+          commit_user_email: "github-actions[bot]@users.noreply.github.com"
+          commit_author: "github-actions[bot] <github-actions[bot]@users.noreply.github.com>"
 
   tests:
     needs:
@@ -54,7 +68,7 @@ jobs:
     timeout-minutes: 1
     strategy:
       matrix:
-        neovim_version: ['v0.9.5', 'v0.10.1', 'v0.11.0']
+        neovim_version: ["v0.7.2", "v0.9.5", "v0.10.4", "v0.11.0"]
 
     steps:
       - uses: actions/checkout@v4

.luarc.json

@@ -1,5 +1,3 @@
 {
-    "diagnostics.globals": [
-        "MiniTest"
-    ]
-}
+  "diagnostics.globals": ["MiniTest", "vim"]
+}

Makefile

@@ -14,6 +14,7 @@ test:
 deps:
 	@mkdir -p deps
 	git clone --depth 1 https://github.com/echasnovski/mini.nvim deps/mini.nvim
+	git clone --depth 1 https://github.com/kdheepak/panvimdoc.git deps/panvimdoc
 
 # installs deps before running tests, useful for the CI.
 test-ci: deps test
@@ -30,6 +31,7 @@ lint:
 	stylua . -g '*.lua' -g '!deps/' -g '!nightly/'
 	luacheck plugin/ lua/
 
+# LuaLS is more capable than luacheck (e.g. catch type errors)
 luals-ci:
 	rm -rf .ci/lua-ls/log
 	lua-language-server --configpath .luarc.json --logpath .ci/lua-ls/log --check .