GeezerVison is showing github.com — adding docs workflow, update readme · nvim-java/nvim-java@49e9938
File tree
Expand file treeCollapse file tree
Open diff view settings
Expand file treeCollapse file tree
Open diff view settings
Collapse file
Copy file name to clipboard +25Lines changed: 25 additions & 0 deletions | Original file line number | Diff line number | Diff line change |
|---|
|
| 1 | +on: |
| 2 | + push: |
| 3 | + branches: |
| 4 | + - main |
| 5 | +name: docs |
| 6 | + |
| 7 | +jobs: |
| 8 | + docs: |
| 9 | + runs-on: ubuntu-latest |
| 10 | + steps: |
| 11 | + - uses: actions/checkout@v3 |
| 12 | + - name: panvimdoc |
| 13 | + uses: kdheepak/panvimdoc@main |
| 14 | + with: |
| 15 | + vimdoc: my-template-docs |
| 16 | + version: "Neovim >= 0.8.0" |
| 17 | + demojify: true |
| 18 | + treesitter: true |
| 19 | + - name: Push changes |
| 20 | + uses: stefanzweifel/git-auto-commit-action@v4 |
| 21 | + with: |
| 22 | + commit_message: "auto-generate vimdoc" |
| 23 | + commit_user_name: "github-actions[bot]" |
| 24 | + commit_user_email: "github-actions[bot]@users.noreply.github.com" |
| 25 | + commit_author: "github-actions[bot] <github-actions[bot]@users.noreply.github.com>" |
Collapse file
Copy file name to clipboardExpand all lines: README.md +5-3Lines changed: 5 additions & 3 deletions - Display the source diff
- Display the rich diff
| Original file line number | Diff line number | Diff line change |
|---|
@@ -22,9 +22,11 @@ Click on `Use this template` |
22 | 22 | ## Features and structure |
23 | 23 |
|
24 | 24 | - 100% Lua |
25 | | -- Github actions to run tests and check for formatting errors (Stylua) |
26 | | -- Tests created with [busted](https://olivinelabs.com/busted/) + [plenary.nvim](https://github.com/nvim-lua/plenary.nvim) |
27 | | -- luarocks release support (LUAROCKS_API_KEY secret configuration required) |
| 25 | +- Github actions for: |
| 26 | + - running tests using [plenary.nvim](https://github.com/nvim-lua/plenary.nvim) and [busted](https://olivinelabs.com/busted/) |
| 27 | + - check for formatting errors (Stylua) |
| 28 | + - vimdocs autogeneration from README.md file |
| 29 | + - luarocks release (LUAROCKS_API_KEY secret configuration required) |
28 | 30 |
|
29 | 31 | ### Plugin structure |
30 | 32 |
|
|
Collapse file
Copy file name to clipboardExpand all lines: doc/my-plugin-template.txt Collapse file
Copy file name to clipboardExpand all lines: doc/my-template-docs.txt