Skip to content

Commit

Permalink
Add workflow for generating documentation (#8)
Browse files Browse the repository at this point in the history
  • Loading branch information
MisanthropicBit authored Apr 6, 2024
1 parent ad8836e commit b8eccac
Show file tree
Hide file tree
Showing 6 changed files with 44 additions and 4 deletions.
40 changes: 40 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
name: autogen-docs

on:
push:
branches: [master]
pull_request:

jobs:
docs:
runs-on: ubuntu-latest
name: generate docs
permissions:
contents: write
steps:
- uses: actions/checkout@v4
with:
ref: ${{ github.head_ref }}
- name: panvimdoc
uses: kdheepak/[email protected]
with:
vimdoc: neotest-busted
pandoc: "README.md"
version: "NVIM >= v0.9.0"
toc: true
description: "Neotest adapter for running tests using busted with neovim as the lua interpreter."
demojify: false
dedupsubheadings: true
treesitter: true
ignorerawblocks: true
docmapping: false
docmappingprojectname: true
shiftheadinglevelby: 0
incrementheadinglevelby: 0
- uses: stefanzweifel/git-auto-commit-action@v4
if: github.ref == 'refs/heads/master'
with:
commit_message: "Auto-generate docs"
commit_user_name: "github-actions[bot]"
commit_user_email: "github-actions[bot]@users.noreply.github.com"
commit_author: "github-actions[bot] <github-actions[bot]@users.noreply.github.com>"
2 changes: 1 addition & 1 deletion .github/workflows/luarocks.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ jobs:
name: upload
steps:
- name: Checkout
uses: actions/checkout@v3
uses: actions/checkout@v4
- uses: leafo/gh-actions-lua@v10
with:
luaVersion: "5.1"
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ jobs:
release:
name: create gh release
runs-on: ubuntu-latest
if: github.ref == 'refs/heads/master'
if: ${{ github.ref == 'refs/heads/master' }}
steps:
- name: Create github release
uses: softprops/action-gh-release@v1
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/style.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ jobs:
name: check
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: actions/checkout@v4
- uses: JohnnyMorganz/stylua-action@v2
with:
token: ${{ secrets.GITHUB_TOKEN }}
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/tests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ jobs:
neovim_version: ['v0.9.0', 'nightly']

steps:
- uses: actions/checkout@v3
- uses: actions/checkout@v4
- run: date +%F > todays-date
- name: Restore cache for today's nightly.
uses: actions/cache@v2
Expand Down
Empty file added doc/.gitkeep
Empty file.

0 comments on commit b8eccac

Please sign in to comment.