aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorStephan Seitz <stephan.seitz@fau.de>2020-08-30 14:29:10 +0200
committerThomas Vigouroux <39092278+vigoux@users.noreply.github.com>2020-08-31 18:53:24 +0200
commitffe7d96dfda89857a757656ba9e4b079fff6e33f (patch)
treefdf6c50b255ff094bb66c0ffa9e18905fe8d9e1b
parentremove second check (diff)
downloadnvim-treesitter-ffe7d96dfda89857a757656ba9e4b079fff6e33f.tar
nvim-treesitter-ffe7d96dfda89857a757656ba9e4b079fff6e33f.tar.gz
nvim-treesitter-ffe7d96dfda89857a757656ba9e4b079fff6e33f.tar.bz2
nvim-treesitter-ffe7d96dfda89857a757656ba9e4b079fff6e33f.tar.lz
nvim-treesitter-ffe7d96dfda89857a757656ba9e4b079fff6e33f.tar.xz
nvim-treesitter-ffe7d96dfda89857a757656ba9e4b079fff6e33f.tar.zst
nvim-treesitter-ffe7d96dfda89857a757656ba9e4b079fff6e33f.zip
feat(CI): auto-update README.md
-rw-r--r--.github/workflows/update-readme.yml22
-rw-r--r--README.md2
-rwxr-xr-xscripts/update-readme.lua3
3 files changed, 17 insertions, 10 deletions
diff --git a/.github/workflows/update-readme.yml b/.github/workflows/update-readme.yml
index 5bbb3729e..69e50f620 100644
--- a/.github/workflows/update-readme.yml
+++ b/.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
- run: ./nvim.appimage --headless -c "TSInstallSync all" -c "q"
-
+ # inspired by nvim-lspconfigs
- 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})
diff --git a/README.md b/README.md
index 886b46ce7..dde61824e 100644
--- a/README.md
+++ b/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)
diff --git a/scripts/update-readme.lua b/scripts/update-readme.lua
index 2a4860c4a..d9c00683a 100755
--- a/scripts/update-readme.lua
+++ b/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