Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: generate vim help docs #103

Merged
merged 23 commits into from
Jan 15, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 35 additions & 0 deletions .github/workflows/docgen.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
name: Generate docs

on:
push:
branches-ignore:
- master

jobs:
docs:
name: Generate docs
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3.0.2
- uses: cachix/install-nix-action@v17
- uses: cachix/cachix-action@v10
with:
name: mrcjkb
authToken: '${{ secrets.CACHIX_AUTH_TOKEN }}'

- name: Generating docs
run: nix run ".#docgen"

- name: Update documentation
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
COMMIT_MSG: |
docs(generated): update doc/haskell-tools.txt
skip-checks: true
run: |
git config user.email "actions@github"
git config user.name "Github Actions"
git remote set-url origin https://x-access-token:${GITHUB_TOKEN}@github.com/${GITHUB_REPOSITORY}.git
git add doc/
# Only commit and push if we have changes
git diff --quiet && git diff --staged --quiet || (git commit -m "${COMMIT_MSG}"; git push origin HEAD:${GITHUB_REF})
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
### Added
- Ability to temporarily set the log level via `ht.log.set_level(level)`.
- `tools.repl.auto_focus` option.
- Vimdocs
### Fixed
- repl.toggleterm: Do not close on failure.
- repl: Quote file names.
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ It is also available on `nixpkgs`.

## Quick Setup

This plugin automatically configures the `haskell-language-server` neovim client and integrates with other haskell tools.
This plugin automatically configures the `haskell-language-server` builtin LSP client and integrates with other haskell tools.
See the [Features](#features) section for more info.

> :warning:
Expand Down
Loading