Skip to content

Commit e027a21

Browse files
committed
ci: improve panvimdoc workflow
1 parent ebb94f1 commit e027a21

File tree

1 file changed

+39
-0
lines changed

1 file changed

+39
-0
lines changed

.github/workflows/panvimdoc.yml

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
name: panvimdoc
2+
3+
on:
4+
push:
5+
branches: [main]
6+
paths:
7+
- README.md
8+
- .github/workflows/panvimdoc.yml
9+
workflow_dispatch: {} # allows manual execution
10+
11+
permissions:
12+
contents: write
13+
14+
#───────────────────────────────────────────────────────────────────────────────
15+
16+
jobs:
17+
docs:
18+
runs-on: ubuntu-latest
19+
name: README.md to vimdoc
20+
steps:
21+
- uses: actions/checkout@v4
22+
- run: git pull # fix failure when multiple commits are pushed in succession
23+
- run: mkdir -p doc
24+
25+
- name: panvimdoc
26+
uses: kdheepak/panvimdoc@main
27+
with:
28+
vimdoc: ${{ github.event.repository.name }}
29+
version: "Neovim"
30+
demojify: true
31+
treesitter: true
32+
toc: false # already has a table of contents in the README
33+
34+
- run: git pull
35+
- name: push changes
36+
uses: stefanzweifel/git-auto-commit-action@v5
37+
with:
38+
commit_message: "chore: auto-generate vimdocs"
39+
branch: ${{ github.head_ref }}

0 commit comments

Comments
 (0)