Skip to content

docs: change documentation #580

docs: change documentation

docs: change documentation #580

Workflow file for this run

name: CI
on:
push:
pull_request:
jobs:
doc:
runs-on: ubuntu-latest
permissions:
checks: write
contents: write
actions: write
id-token: write
steps:
- uses: actions/checkout@v4
with:
ref: ${{ github.head_ref }}
- name: Install lua
uses: leafo/gh-actions-lua@v10
with:
luaVersion: "luajit-2.1.0-beta3"
- name: Install luarocks
uses: leafo/gh-actions-luarocks@v4
- name: Install inspect
run: luarocks install inspect
- name: Generate docs
run: make doc
- name: Commit changes
uses: stefanzweifel/git-auto-commit-action@v5
with:
file_pattern: README.md doc/crates.txt docgen/wiki
commit_message: "chore: generate docs"
wiki:
runs-on: ubuntu-latest
needs: doc
if: github.ref == 'refs/heads/main'
steps:
- name: Upload Documentation to Wiki
uses: spenserblack/actions-wiki@v0.3.0
with:
path: docgen/wiki
test:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
with:
path: crates.nvim
- name: Install neovim
uses: rhysd/action-setup-vim@v1
with:
neovim: true
- name: Install plenary.nvim
uses: actions/checkout@v4
with:
repository: nvim-lua/plenary.nvim
path: plenary.nvim
- name: Run tests
run: make test
working-directory: crates.nvim
timeout-minutes: 1