browsher.nvim/.github/workflows/docs_update.yml at main · claydugo/browsher.nvim · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
name: Generate documentation

on:
  push:
    branches:
      - main
    paths:
      - 'README.md'
      - 'lua/**'
      - 'plugin/**'

permissions:
  contents: write

jobs:
  generate-docs:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout repository
        uses: actions/checkout@v3

      - name: Generate Vim documentation
        uses: kdheepak/panvimdoc@main
        with:
          vimdoc: browsher
          pandoc: "README.md"
          description: "Create commit pinned links to git(hub | lab) hosted files/lines directly from Neovim"
          toc: true
          demojify: true

      - name: Commit and push changes
        uses: stefanzweifel/git-auto-commit-action@v4
        with:
          commit_message: 'auto generate vimdoc'
          branch: ${{ github.ref }}
          file_pattern: doc/browsher.txt
          commit_user_name: 'github-actions[bot]'
          commit_user_email: 'github-actions[bot]@users.noreply.github.com'