|
10 | 10 |
|
11 | 11 | - interactive `setup` script |
12 | 12 | - README.md template |
13 | | -- GitHub Release script |
14 | 13 | - Perfect for open-source: |
15 | 14 | - CODEOWNERS file for PR auto-assign |
16 | 15 | - Issues and PR templates |
17 | | -- CI with GitHub actions: |
| 16 | +- CD leveraging [release-please-action](https://github.com/google-github-actions/release-please-action) |
| 17 | +- CI: |
18 | 18 | - Test running on multiple Neovim version |
19 | 19 | - Lint check |
20 | 20 | - Documentation generation check |
21 | 21 | - Minimal run time, ideal for free plans |
22 | 22 | - Docs with [mini.nvim `doc` plugin](https://github.com/echasnovski/mini.nvim/blob/main/lua/mini/doc.lua) |
23 | 23 | - Tests with [mini.nvim `test` plugin](https://github.com/echasnovski/mini.nvim/blob/main/lua/mini/test.lua) |
24 | 24 | - Linting with [Stylua](https://github.com/JohnnyMorganz/StyLua) |
25 | | -- Changelog with [git-chglog](https://github.com/git-chglog/git-chglog) |
26 | 25 |
|
27 | 26 | ## 📋 Installation |
28 | 27 |
|
29 | 28 | > **Note**: |
30 | | -> This section is only required if you wish to use the linter and changelog generator provided by the template. |
| 29 | +> This section is only required if you wish to use the linter provided by the template. |
31 | 30 |
|
32 | 31 | - [Install Stylua linter](https://github.com/JohnnyMorganz/StyLua#installation) |
33 | | -- [Install git-chglog generator](https://github.com/git-chglog/git-chglog) |
34 | 32 |
|
35 | 33 | ## ☄ Getting started |
36 | 34 |
|
@@ -93,10 +91,10 @@ mv README_TEMPLATE.md README.md |
93 | 91 | :vimgrep /your-plugin-name/ **/* .github/** |
94 | 92 | :cfdo %s/your-plugin-name/my-awesome-plugin/g | update |
95 | 93 |
|
96 | | -:vimgrep /YOUR_GITHUB_USERNAME/ .chglog/** .github/** **/*.md |
| 94 | +:vimgrep /YOUR_GITHUB_USERNAME/ .github/** **/*.md |
97 | 95 | :cfdo %s/YOUR_GITHUB_USERNAME/shortcuts/g | update |
98 | 96 |
|
99 | | -:vimgrep /YOUR_REPOSITORY_NAME/ .chglog/** **/*.md |
| 97 | +:vimgrep /YOUR_REPOSITORY_NAME/ **/*.md |
100 | 98 | :cfdo %s/YOUR_REPOSITORY_NAME/my-awesome-plugin.nvim/g | update |
101 | 99 | ``` |
102 | 100 |
|
|
0 commit comments