3b930636e3
* docs: centralize documentation into helpdoc Problem: documentation was spread across four files (README.md, doc/oil.txt, doc/api.md, doc/recipes.md) with duplication and gaps. User events were undocumented, and adapter docs only lived in the README. Solution: expand doc/oil.txt with five new sections (introduction, requirements, adapters, recipes, events) from existing content. Trim README to a landing page pointing to :help oil. Delete doc/api.md and doc/recipes.md since their content now lives in the helpdoc. Closes: barrettruth/oil.nvim#6 * build: remove docgen pipeline Problem: the Python docgen pipeline (scripts/generate.py, scripts/main.py, nvim_doc_tools) was designed for upstream's doc layout and is incompatible with the centralized helpdoc structure. It overwrites doc/oil.txt entirely and expects sections in README.md that no longer exist. Solution: delete the pipeline scripts (generate.py, main.py, requirements.txt), remove the update_docs CI job, and clean up the Makefile and .gitignore references. Linting and typechecking remain unchanged.
95 lines
2 KiB
YAML
95 lines
2 KiB
YAML
name: Tests
|
|
|
|
on:
|
|
push:
|
|
branches:
|
|
- main
|
|
pull_request:
|
|
branches:
|
|
- main
|
|
|
|
jobs:
|
|
luacheck:
|
|
name: Luacheck
|
|
runs-on: ubuntu-22.04
|
|
steps:
|
|
- uses: actions/checkout@v4
|
|
|
|
- name: Prepare
|
|
run: |
|
|
sudo apt-get update
|
|
sudo add-apt-repository universe
|
|
sudo apt install luarocks -y
|
|
sudo luarocks install luacheck
|
|
|
|
- name: Run Luacheck
|
|
run: luacheck lua tests
|
|
|
|
stylua:
|
|
name: StyLua
|
|
runs-on: ubuntu-22.04
|
|
steps:
|
|
- uses: actions/checkout@v4
|
|
- name: Stylua
|
|
uses: JohnnyMorganz/stylua-action@v4
|
|
with:
|
|
token: ${{ secrets.GITHUB_TOKEN }}
|
|
version: v2.0.2
|
|
args: --check lua tests
|
|
|
|
typecheck:
|
|
name: typecheck
|
|
runs-on: ubuntu-22.04
|
|
steps:
|
|
- uses: actions/checkout@v4
|
|
- uses: stevearc/nvim-typecheck-action@v2
|
|
with:
|
|
path: lua
|
|
|
|
run_tests:
|
|
strategy:
|
|
matrix:
|
|
include:
|
|
- nvim_tag: v0.8.3
|
|
- nvim_tag: v0.9.4
|
|
- nvim_tag: v0.10.4
|
|
- nvim_tag: v0.11.0
|
|
|
|
name: Run tests
|
|
runs-on: ubuntu-22.04
|
|
env:
|
|
NVIM_TAG: ${{ matrix.nvim_tag }}
|
|
steps:
|
|
- uses: actions/checkout@v4
|
|
|
|
- name: Install Neovim and dependencies
|
|
run: |
|
|
bash ./.github/workflows/install_nvim.sh
|
|
|
|
- name: Run tests
|
|
run: |
|
|
bash ./run_tests.sh
|
|
|
|
release:
|
|
name: release
|
|
|
|
if: ${{ github.ref == 'refs/heads/main' }}
|
|
needs:
|
|
- luacheck
|
|
- stylua
|
|
- typecheck
|
|
- run_tests
|
|
runs-on: ubuntu-22.04
|
|
steps:
|
|
- uses: googleapis/release-please-action@v4
|
|
id: release
|
|
with:
|
|
release-type: simple
|
|
- uses: actions/checkout@v4
|
|
- uses: rickstaa/action-create-tag@v1
|
|
if: ${{ steps.release.outputs.release_created }}
|
|
with:
|
|
tag: stable
|
|
message: "Current stable release: ${{ steps.release.outputs.tag_name }}"
|
|
tag_exists_error: false
|
|
force_push_tag: true
|