feat(CI): auto-update README.md

.github/workflows/update-readme.yml

@@ -1,11 +1,12 @@
 name: Check README parser info
 
-on: [push, pull_request]
+on: push
 
 jobs:
-  luacheck:
+  update-readme:
     name: Check README parser info
     runs-on: ubuntu-latest
+    if: github.ref != 'master'
     steps:
       - uses: actions/checkout@v1
 
@@ -18,8 +19,17 @@ jobs:
           mkdir -p ~/.local/share/nvim/site/pack/nvim-treesitter/start
           ln -s $(pwd) ~/.local/share/nvim/site/pack/nvim-treesitter/start
 
-      - name: Compile parsers
+      # inspired by nvim-lspconfigs
-        run: ./nvim.appimage --headless -c "TSInstallSync all" -c "q"
-
       - name: Check README
-        run: ./nvim.appimage --headless -c "luafile ./scripts/update-readme.lua" -c "q"
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          COMMIT_MSG: |
+            [docgen] Update README.md
+            skip-checks: true
+        run: |
+          git config user.email "actions@github"
+          git config user.name "Github Actions"
+          git remote set-url origin https://x-access-token:${GITHUB_TOKEN}@github.com/${GITHUB_REPOSITORY}.git
+          ./nvim.appimage --headless -c "luafile ./scripts/update-readme.lua" -c "q" || git add README.md
+          # Only commit and push if we have changes
+          git diff --quiet && git diff --staged --quiet || (git commit -m "${COMMIT_MSG}"; git push origin HEAD:${GITHUB_REF})

README.md

@@ -330,7 +330,7 @@ We are looking for maintainers to write query files for their languages.
 
 List of currently supported languages:
 
-<!--Update this section by running `nvim --headless -c "luafile ./scripts/update-readme.lua"`-->
+<!--This section of the README is automatically updated by a CI job-->
 <!--parserinfo-->
 - [x] [bash](https://github.com/tree-sitter/tree-sitter-bash) (maintained by @TravonteD)
 - [x] [c](https://github.com/tree-sitter/tree-sitter-c) (maintained by @vigoux)

scripts/update-readme.lua

@@ -37,8 +37,5 @@ if string.find(readme_text, generated_text, 1, 'plain') then
 else
   print("New README.md was written. Please commit that change! Old text was: ")
   print(string.sub(readme_text, string.find(readme_text, "<!%-%-parserinfo%-%->.*<!%-%-parserinfo%-%->")))
-  print("\n")
-  print('If you see this on CI, please run `nvim --headless -c "luafile ./scripts/update-readme.lua"` '
-      ..'locally and commit the changes!')
   vim.cmd('cq')
 end