Skip to content

Commit

Permalink
ci: improve panvimdoc workflow
Browse files Browse the repository at this point in the history
  • Loading branch information
chrisgrieser committed Nov 26, 2024
1 parent 8d8b689 commit 55216d2
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 317 deletions.
26 changes: 18 additions & 8 deletions .github/workflows/panvimdoc.yml
Original file line number Diff line number Diff line change
@@ -1,29 +1,39 @@
name: Auto-generate vimdocs
name: panvimdoc

on:
push:
branches: [main]
paths:
- README.md # source file
- .github/workflows/panvimdoc.yml # updates to this file itself
workflow_dispatch:
- README.md
- .github/workflows/panvimdoc.yml
workflow_dispatch: {} # allows manual execution

permissions:
contents: write

#───────────────────────────────────────────────────────────────────────────────

jobs:
docs:
runs-on: ubuntu-latest
name: README.md to vimdoc
steps:
- uses: actions/checkout@v4
- uses: kdheepak/panvimdoc@main
- run: git pull # fix failure when multiple commits are pushed in succession
- run: mkdir -p doc

- name: panvimdoc
uses: kdheepak/panvimdoc@main
with:
vimdoc: rulebook
vimdoc: ${{ github.event.repository.name }}
version: "Neovim"
demojify: true
treesitter: true
description: " Auto-generated from README.md. Do not make PRs to this file."
- uses: stefanzweifel/git-auto-commit-action@v5
toc: false # already has a table of contents in the README

- run: git pull
- name: push changes
uses: stefanzweifel/git-auto-commit-action@v5
with:
commit_message: "chore: auto-generate vimdocs"
branch: ${{ github.head_ref }}
309 changes: 0 additions & 309 deletions doc/rulebook.txt

This file was deleted.

0 comments on commit 55216d2

Please sign in to comment.