Skip to content

Commit fbbe7a1

Browse files
committed
docs: auto-generate OPTIONS.md from emmylua comments
1 parent b949bc0 commit fbbe7a1

File tree

8 files changed

+3630
-1449
lines changed

8 files changed

+3630
-1449
lines changed

.github/workflows/vimdoc.yaml

Lines changed: 18 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ name: vimdoc
22

33
on:
44
push:
5-
branches: [main, vimdoc]
5+
branches: [main, vimdoc, fix-gen-opts]
66

77
jobs:
88
generate-docs:
@@ -24,11 +24,26 @@ jobs:
2424
run: |
2525
export PACKPATH=$HOME/.local/share/nvim/site
2626
nvim --headless -u ~/.local/share/nvim/site/pack/vendor/start/ts-vimdoc.nvim/scripts/init.lua -c "TSUpdateSync markdown" -c "TSUpdateSync markdown_inline" -c "qa"
27-
- name: Generating docs
27+
- name: Generating vimdoc
2828
run: |
2929
export PATH="${PWD}/build/:${PATH}"
3030
export PACKPATH=$HOME/.local/share/nvim/site
3131
nvim --headless -u ~/.local/share/nvim/site/pack/vendor/start/ts-vimdoc.nvim/scripts/init.lua -c "lua require('ts-vimdoc').docgen({input_file='README.md', output_file='doc/fzf-lua.txt', project_name='fzf-lua', version='For Neovim >= 0.9.0'})" -c "qa"
32+
nvim --headless -u ~/.local/share/nvim/site/pack/vendor/start/ts-vimdoc.nvim/scripts/init.lua -c "lua require('ts-vimdoc').docgen({input_file='OPTIONS.md', output_file='doc/fzf-lua-opts.txt', project_name='fzf-lua-opts', table_of_contents_lvl_min = 2, table_of_contents_lvl_max = 3, version='For Neovim >= 0.9.0'})" -c "qa"
33+
- name: Install emmylua_doc_cli
34+
env:
35+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
36+
run: |
37+
set -e
38+
cd
39+
gh release download -R EmmyLuaLs/emmylua-analyzer-rust -p emmylua_doc_cli-linux-x64.tar.gz -D emmylua_doc_cli
40+
tar xzf emmylua_doc_cli/* -C emmylua_doc_cli
41+
echo "${PWD}/emmylua_doc_cli/" >> $GITHUB_PATH
42+
export PATH="${PWD}/emmylua_doc_cli/:${PATH}"
43+
emmylua_doc_cli --version
44+
- name: Generating OPTIONS.md
45+
run: |
46+
nvim --headless -l scripts/gen_options.lua
3247
- name: Commit changes
3348
env:
3449
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
@@ -39,6 +54,6 @@ jobs:
3954
git config user.email "actions@github"
4055
git config user.name "Github Actions"
4156
git remote set-url origin https://x-access-token:${GITHUB_TOKEN}@github.com/${GITHUB_REPOSITORY}.git
42-
git add doc/fzf-lua.txt
57+
git add doc OPTIONS.md
4358
# Only commit and push if we have changes
4459
git diff --quiet && git diff --staged --quiet || (git commit -m "${COMMIT_MSG}"; git push origin HEAD:${GITHUB_REF})

0 commit comments

Comments
 (0)