Skip to content

Commit fff6c56

Browse files
ColinKennedyColinKennedy
committed
fix(mdformat): removed CHANGELOG.md management + added to README.md
1 parent ef88025 commit fff6c56

4 files changed

Lines changed: 26 additions & 25 deletions

File tree

‎.github/workflows/release-github.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
#
33
# References:
44
# https://github.com/nvim-neorocks/sample-luarocks-plugin?tab=readme-ov-file#installing-release-please-recommended
5-
# Reference: https://github.com/nvim-neorocks/sample-luarocks-plugin?tab=readme-ov-file#generating-a-pat-personal-access-token
5+
# https://github.com/nvim-neorocks/sample-luarocks-plugin?tab=readme-ov-file#generating-a-pat-personal-access-token
66
#
77
name: Release To GitHub
88

‎CHANGELOG.md‎

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -12,112 +12,112 @@
1212

1313
### Features
1414

15-
- **ci:** added LuaCov support ([0585a10](https://github.com/ColinKennedy/nvim-best-practices-plugin-template/commit/0585a10f66360b2b2f9b2642296fa732c222683f))
16-
- **ci:** added LuaCov support ([df5ae92](https://github.com/ColinKennedy/nvim-best-practices-plugin-template/commit/df5ae92ac3427d4af899e3a9cb2e561e1eac3fde))
15+
* **ci:** added LuaCov support ([0585a10](https://github.com/ColinKennedy/nvim-best-practices-plugin-template/commit/0585a10f66360b2b2f9b2642296fa732c222683f))
16+
* **ci:** added LuaCov support ([df5ae92](https://github.com/ColinKennedy/nvim-best-practices-plugin-template/commit/df5ae92ac3427d4af899e3a9cb2e561e1eac3fde))
1717

1818
## [1.9.0](https://github.com/ColinKennedy/nvim-best-practices-plugin-template/compare/v1.8.0...v1.9.0) (2025-04-06)
1919

2020
### Features
2121

22-
- **neovim:** added neovim version v0.11.0 support ([a02c0b3](https://github.com/ColinKennedy/nvim-best-practices-plugin-template/commit/a02c0b303726b5259b3cbc0a2b6acebb98c55c15))
22+
* **neovim:** added neovim version v0.11.0 support ([a02c0b3](https://github.com/ColinKennedy/nvim-best-practices-plugin-template/commit/a02c0b303726b5259b3cbc0a2b6acebb98c55c15))
2323

2424
## [1.8.0](https://github.com/ColinKennedy/nvim-best-practices-plugin-template/compare/v1.7.1...v1.8.0) (2025-03-21)
2525

2626
### Features
2727

28-
- **checkhealth:** added automated :checkhealth CI command ([b0f0ccf](https://github.com/ColinKennedy/nvim-best-practices-plugin-template/commit/b0f0ccfc177cf42cd17faf435b40ca5b39f478f1))
28+
* **checkhealth:** added automated :checkhealth CI command ([b0f0ccf](https://github.com/ColinKennedy/nvim-best-practices-plugin-template/commit/b0f0ccfc177cf42cd17faf435b40ca5b39f478f1))
2929

3030
## [1.7.1](https://github.com/ColinKennedy/nvim-best-practices-plugin-template/compare/v1.7.0...v1.7.1) (2025-02-27)
3131

3232
### Bug Fixes
3333

34-
- **ci:** baptiste0928/cargo-install version key removed ([e9bb024](https://github.com/ColinKennedy/nvim-best-practices-plugin-template/commit/e9bb024fe7f9a067f70a84c6d67ebb567f9a5d83))
34+
* **ci:** baptiste0928/cargo-install version key removed ([e9bb024](https://github.com/ColinKennedy/nvim-best-practices-plugin-template/commit/e9bb024fe7f9a067f70a84c6d67ebb567f9a5d83))
3535

3636
## [1.7.0](https://github.com/ColinKennedy/nvim-best-practices-plugin-template/compare/v1.6.0...v1.7.0) (2025-02-06)
3737

3838
### Features
3939

40-
- **docs:** added automated uploads to gh-pages ([af8b2e5](https://github.com/ColinKennedy/nvim-best-practices-plugin-template/commit/af8b2e5ae9cb0681ca27973787487502156fe2c2))
40+
* **docs:** added automated uploads to gh-pages ([af8b2e5](https://github.com/ColinKennedy/nvim-best-practices-plugin-template/commit/af8b2e5ae9cb0681ca27973787487502156fe2c2))
4141

4242
## [1.6.0](https://github.com/ColinKennedy/nvim-best-practices-plugin-template/compare/v1.5.5...v1.6.0) (2025-01-25)
4343

4444
### Features
4545

46-
- **os:** added windows support ([7a3c6c7](https://github.com/ColinKennedy/nvim-best-practices-plugin-template/commit/7a3c6c794712883399626d3177b6ce93cf0252a4))
46+
* **os:** added windows support ([7a3c6c7](https://github.com/ColinKennedy/nvim-best-practices-plugin-template/commit/7a3c6c794712883399626d3177b6ce93cf0252a4))
4747

4848
## [1.5.5](https://github.com/ColinKennedy/nvim-best-practices-plugin-template/compare/v1.5.4...v1.5.5) (2025-01-11)
4949

5050
### Bug Fixes
5151

52-
- **rockspec:** removed lualine because it is still WIP ([121681f](https://github.com/ColinKennedy/nvim-best-practices-plugin-template/commit/121681f8f7ace45e114ea2161175e37c8c8e4877))
52+
* **rockspec:** removed lualine because it is still WIP ([121681f](https://github.com/ColinKennedy/nvim-best-practices-plugin-template/commit/121681f8f7ace45e114ea2161175e37c8c8e4877))
5353

5454
## [1.5.4](https://github.com/ColinKennedy/nvim-best-practices-plugin-template/compare/v1.5.3...v1.5.4) (2025-01-11)
5555

5656
### Bug Fixes
5757

58-
- **rockspec:** added missing lua dependencies ([ac4aea4](https://github.com/ColinKennedy/nvim-best-practices-plugin-template/commit/ac4aea4f468b4912e694eb4fca0305aff026f4e1))
58+
* **rockspec:** added missing lua dependencies ([ac4aea4](https://github.com/ColinKennedy/nvim-best-practices-plugin-template/commit/ac4aea4f468b4912e694eb4fca0305aff026f4e1))
5959

6060
## [1.5.3](https://github.com/ColinKennedy/nvim-best-practices-plugin-template/compare/v1.5.2...v1.5.3) (2025-01-11)
6161

6262
### Bug Fixes
6363

64-
- **rockspec:** updated package name ([2445735](https://github.com/ColinKennedy/nvim-best-practices-plugin-template/commit/2445735817e93ccb520101539c2f41312e0635b3))
64+
* **rockspec:** updated package name ([2445735](https://github.com/ColinKennedy/nvim-best-practices-plugin-template/commit/2445735817e93ccb520101539c2f41312e0635b3))
6565

6666
## [1.5.2](https://github.com/ColinKennedy/nvim-best-practices-plugin-template/compare/v1.5.1...v1.5.2) (2025-01-11)
6767

6868
### Bug Fixes
6969

70-
- **logging:** fixed fmt_warning calls + others ([0e44922](https://github.com/ColinKennedy/nvim-best-practices-plugin-template/commit/0e449223755ab4ea4fa170753d4b38731e4279b2))
71-
- **rockspec:** the .rockspec should now publish to LuaRocks correctly ([7f995ef](https://github.com/ColinKennedy/nvim-best-practices-plugin-template/commit/7f995ef9b4459bb47976303825adb7a81737f404))
70+
* **logging:** fixed fmt_warning calls + others ([0e44922](https://github.com/ColinKennedy/nvim-best-practices-plugin-template/commit/0e449223755ab4ea4fa170753d4b38731e4279b2))
71+
* **rockspec:** the .rockspec should now publish to LuaRocks correctly ([7f995ef](https://github.com/ColinKennedy/nvim-best-practices-plugin-template/commit/7f995ef9b4459bb47976303825adb7a81737f404))
7272

7373
## [1.5.1](https://github.com/ColinKennedy/nvim-best-practices-plugin-template/compare/v1.5.0...v1.5.1) (2024-12-23)
7474

7575
### Bug Fixes
7676

77-
- **ci:** urlchecker ignored during release ([f4faf3b](https://github.com/ColinKennedy/nvim-best-practices-plugin-template/commit/f4faf3b557c3fff211195bdc05003b701e895196))
77+
* **ci:** urlchecker ignored during release ([f4faf3b](https://github.com/ColinKennedy/nvim-best-practices-plugin-template/commit/f4faf3b557c3fff211195bdc05003b701e895196))
7878

7979
## [1.5.0](https://github.com/ColinKennedy/nvim-best-practices-plugin-template/compare/v1.4.0...v1.5.0) (2024-12-13)
8080

8181
### Features
8282

83-
- **dependencies:** moved cmdparse + logging out ([83458f2](https://github.com/ColinKennedy/nvim-best-practices-plugin-template/commit/83458f230192cb1a77778de051bcde757e73d756))
83+
* **dependencies:** moved cmdparse + logging out ([83458f2](https://github.com/ColinKennedy/nvim-best-practices-plugin-template/commit/83458f230192cb1a77778de051bcde757e73d756))
8484

8585
### Bug Fixes
8686

87-
- **missing:** added missing .gitignore ([6def002](https://github.com/ColinKennedy/nvim-best-practices-plugin-template/commit/6def002a458edbf6dcaf786120b3e3f3fbcd869b))
87+
* **missing:** added missing .gitignore ([6def002](https://github.com/ColinKennedy/nvim-best-practices-plugin-template/commit/6def002a458edbf6dcaf786120b3e3f3fbcd869b))
8888

8989
## [1.4.0](https://github.com/ColinKennedy/nvim-best-practices-plugin-template/compare/v1.3.2...v1.4.0) (2024-12-05)
9090

9191
### Features
9292

93-
- **dependencies:** removed unneeded git submodules ([58bba30](https://github.com/ColinKennedy/nvim-best-practices-plugin-template/commit/58bba307be8ec2a963b8d0ec256d60d9c14abe16))
93+
* **dependencies:** removed unneeded git submodules ([58bba30](https://github.com/ColinKennedy/nvim-best-practices-plugin-template/commit/58bba307be8ec2a963b8d0ec256d60d9c14abe16))
9494

9595
## [1.3.2](https://github.com/ColinKennedy/nvim-best-practices-plugin-template/compare/v1.3.1...v1.3.2) (2024-11-12)
9696

9797
### Bug Fixes
9898

99-
- **luals:** Added missing diagnostics paths ([d5f93ef](https://github.com/ColinKennedy/nvim-best-practices-plugin-template/commit/d5f93ef89c47ae5dd09c684526f7050a0f829e11))
99+
* **luals:** Added missing diagnostics paths ([d5f93ef](https://github.com/ColinKennedy/nvim-best-practices-plugin-template/commit/d5f93ef89c47ae5dd09c684526f7050a0f829e11))
100100

101101
## [1.3.1](https://github.com/ColinKennedy/nvim-best-practices-plugin-template/compare/v1.3.0...v1.3.1) (2024-10-26)
102102

103103
### Bug Fixes
104104

105-
- **urlchecker:** Added README.md + CHANGELOG.md as a checker ([a4b7d41](https://github.com/ColinKennedy/nvim-best-practices-plugin-template/commit/a4b7d410f4d853d7bf98e4ca6dc198f6ea29bb8d))
105+
* **urlchecker:** Added README.md + CHANGELOG.md as a checker ([a4b7d41](https://github.com/ColinKennedy/nvim-best-practices-plugin-template/commit/a4b7d410f4d853d7bf98e4ca6dc198f6ea29bb8d))
106106

107107
## [1.3.0](https://github.com/ColinKennedy/nvim-best-practices-plugin-template/compare/v1.2.0...v1.3.0) (2024-10-26)
108108

109109
### Features
110110

111-
- **ci:** Added urlchecker.yml ([764f485](https://github.com/ColinKennedy/nvim-best-practices-plugin-template/commit/764f4859522c6c810e75bd82eda6073ef4fc0c0c))
111+
* **ci:** Added urlchecker.yml ([764f485](https://github.com/ColinKennedy/nvim-best-practices-plugin-template/commit/764f4859522c6c810e75bd82eda6073ef4fc0c0c))
112112

113113
## [1.2.0](https://github.com/ColinKennedy/nvim-best-practices-plugin-template/compare/v1.1.0...v1.2.0) (2024-10-26)
114114

115115
### Features
116116

117-
- **ci:** Enabled llscheck.yml ([18273bf](https://github.com/ColinKennedy/nvim-best-practices-plugin-template/commit/18273bf3526364ca05d2798318b86f59a3c124e8))
117+
* **ci:** Enabled llscheck.yml ([18273bf](https://github.com/ColinKennedy/nvim-best-practices-plugin-template/commit/18273bf3526364ca05d2798318b86f59a3c124e8))
118118

119119
## [1.1.0](https://github.com/ColinKennedy/nvim-best-practices-plugin-template/compare/v1.0.3...v1.1.0) (2024-10-26)
120120

121121
### Features
122122

123-
- **ci:** Added better GitHub workflows ([da48f5a](https://github.com/ColinKennedy/nvim-best-practices-plugin-template/commit/da48f5a27fb01e9c597d82931e551d10c31b94d0))
123+
* **ci:** Added better GitHub workflows ([da48f5a](https://github.com/ColinKennedy/nvim-best-practices-plugin-template/commit/da48f5a27fb01e9c597d82931e551d10c31b94d0))

‎Makefile‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,10 +37,10 @@ test: download-dependencies
3737
busted .
3838

3939
check-mdformat:
40-
python -m mdformat --check CHANGELOG.md README.md markdown/manual/docs/index.md
40+
python -m mdformat --check README.md markdown/manual/docs/index.md
4141

4242
mdformat:
43-
python -m mdformat CHANGELOG.md README.md markdown/manual/docs/index.md
43+
python -m mdformat README.md markdown/manual/docs/index.md
4444

4545
# IMPORTANT: Make sure to run this first
4646
# ```

‎README.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ A template repository used to create Neovim plugins.
44

55
| <!-- --> | <!-- --> |
66
|--------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
7-
| Build Status | [![unittests](https://img.shields.io/github/actions/workflow/status/ColinKennedy/nvim-best-practices-plugin-template/test.yml?branch=main&style=for-the-badge&label=Unittests)](https://github.com/ColinKennedy/nvim-best-practices-plugin-template/actions/workflows/test.yml) [![documentation](https://img.shields.io/github/actions/workflow/status/ColinKennedy/nvim-best-practices-plugin-template/documentation.yml?branch=main&style=for-the-badge&label=Documentation)](https://github.com/ColinKennedy/nvim-best-practices-plugin-template/actions/workflows/documentation.yml) [![luacheck](https://img.shields.io/github/actions/workflow/status/ColinKennedy/nvim-best-practices-plugin-template/luacheck.yml?branch=main&style=for-the-badge&label=Luacheck)](https://github.com/ColinKennedy/nvim-best-practices-plugin-template/actions/workflows/luacheck.yml) [![llscheck](https://img.shields.io/github/actions/workflow/status/ColinKennedy/nvim-best-practices-plugin-template/llscheck.yml?branch=main&style=for-the-badge&label=llscheck)](https://github.com/ColinKennedy/nvim-best-practices-plugin-template/actions/workflows/llscheck.yml) [![checkhealth](https://img.shields.io/github/actions/workflow/status/ColinKennedy/nvim-best-practices-plugin-template/checkhealth.yml?branch=main&style=for-the-badge&label=checkhealth)](https://github.com/ColinKennedy/nvim-best-practices-plugin-template/actions/workflows/checkhealth.yml) [![stylua](https://img.shields.io/github/actions/workflow/status/ColinKennedy/nvim-best-practices-plugin-template/stylua.yml?branch=main&style=for-the-badge&label=Stylua)](https://github.com/ColinKennedy/nvim-best-practices-plugin-template/actions/workflows/stylua.yml) [![urlchecker](https://img.shields.io/github/actions/workflow/status/ColinKennedy/nvim-best-practices-plugin-template/urlchecker.yml?branch=main&style=for-the-badge&label=URLChecker)](https://github.com/ColinKennedy/nvim-best-practices-plugin-template/actions/workflows/urlchecker.yml) |
7+
| Build Status | [![unittests](https://img.shields.io/github/actions/workflow/status/ColinKennedy/nvim-best-practices-plugin-template/test.yml?branch=main&style=for-the-badge&label=Unittests)](https://github.com/ColinKennedy/nvim-best-practices-plugin-template/actions/workflows/test.yml) [![documentation](https://img.shields.io/github/actions/workflow/status/ColinKennedy/nvim-best-practices-plugin-template/documentation.yml?branch=main&style=for-the-badge&label=Documentation)](https://github.com/ColinKennedy/nvim-best-practices-plugin-template/actions/workflows/documentation.yml) [![luacheck](https://img.shields.io/github/actions/workflow/status/ColinKennedy/nvim-best-practices-plugin-template/luacheck.yml?branch=main&style=for-the-badge&label=Luacheck)](https://github.com/ColinKennedy/nvim-best-practices-plugin-template/actions/workflows/luacheck.yml) [![llscheck](https://img.shields.io/github/actions/workflow/status/ColinKennedy/nvim-best-practices-plugin-template/llscheck.yml?branch=main&style=for-the-badge&label=llscheck)](https://github.com/ColinKennedy/nvim-best-practices-plugin-template/actions/workflows/llscheck.yml) [![checkhealth](https://img.shields.io/github/actions/workflow/status/ColinKennedy/nvim-best-practices-plugin-template/checkhealth.yml?branch=main&style=for-the-badge&label=checkhealth)](https://github.com/ColinKennedy/nvim-best-practices-plugin-template/actions/workflows/checkhealth.yml) [![stylua](https://img.shields.io/github/actions/workflow/status/ColinKennedy/nvim-best-practices-plugin-template/stylua.yml?branch=main&style=for-the-badge&label=Stylua)](https://github.com/ColinKennedy/nvim-best-practices-plugin-template/actions/workflows/stylua.yml) [![urlchecker](https://img.shields.io/github/actions/workflow/status/ColinKennedy/nvim-best-practices-plugin-template/urlchecker.yml?branch=main&style=for-the-badge&label=URLChecker)](https://github.com/ColinKennedy/nvim-best-practices-plugin-template/actions/workflows/urlchecker.yml) [![mdformat](https://img.shields.io/github/actions/workflow/status/ColinKennedy/nvim-best-practices-plugin-template/mdformat.yml?branch=main&style=for-the-badge&label=mdformat)](https://github.com/ColinKennedy/nvim-best-practices-plugin-template/actions/workflows/mdformat.yml) |
88
| License | [![License-MIT](https://img.shields.io/badge/License-MIT-blue?style=for-the-badge)](https://github.com/ColinKennedy/nvim-best-practices-plugin-template/blob/main/LICENSE) |
99
| Social | [![RSS](https://img.shields.io/badge/rss-F88900?style=for-the-badge&logo=rss&logoColor=white)](https://github.com/ColinKennedy/nvim-best-practices-plugin-template/commits/main/doc/news.txt.atom) |
1010

@@ -42,6 +42,7 @@ A template repository used to create Neovim plugins.
4242
- [luacheck](https://github.com/mpeterv/luacheck) - Checks for Lua code issues
4343
- [luarocks](https://luarocks.org) auto-release ([LUAROCKS_API_KEY secret](https://github.com/nvim-neorocks/sample-luarocks-plugin?tab=readme-ov-file#publishing-to-luarocks) configuration required)
4444
- [GitHub](https://github.com/ColinKennedy/nvim-best-practices-plugin-template/releases) auto-release ([PERSONAL_ACCESS_TOKEN secret](https://github.com/nvim-neorocks/sample-luarocks-plugin?tab=readme-ov-file#installing-release-please-recommended) configuration required)
45+
- [mdformat](https://github.com/hukkin/mdformat) - Auto-formats project Markdown files
4546
- [mini.doc](https://github.com/echasnovski/mini.doc) - API documentation auto-generator
4647
- [panvimdoc](https://github.com/kdheepak/panvimdoc) - User documentation auto-generator
4748
- [emmylua_doc_cli](https://github.com/CppCXY/emmylua-analyzer-rust/tree/main/crates/emmylua_doc_cli) & [mkdocs-material](https://github.com/squidfunk/mkdocs-material) - Generate HTML from Lua files automatically

0 commit comments

Comments
 (0)