aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authordundargoc <33953936+dundargoc@users.noreply.github.com>2023-02-10 17:03:01 +0100
committerGitHub <noreply@github.com>2023-02-10 17:03:01 +0100
commite5d8220179f932ab9c9ef59996cab357a25eaaf8 (patch)
tree75ee9a30c25d70b704d750188837a2b13bde6f90
parentd5b1712dc4ced82e15a9a736626d4e2e3370c9b4 (diff)
downloadrneovim-e5d8220179f932ab9c9ef59996cab357a25eaaf8.tar.gz
rneovim-e5d8220179f932ab9c9ef59996cab357a25eaaf8.tar.bz2
rneovim-e5d8220179f932ab9c9ef59996cab357a25eaaf8.zip
ci: simplify lintcommit output (#22204)
- Suggest reading CONTRIBUTING.md once, not for each commit failure - Suggest using "fix" type if none of the provided types are appropriate - Remove "dist" type. It's rarely used and can be replaced by using the "build" type
-rw-r--r--CONTRIBUTING.md2
-rw-r--r--scripts/lintcommit.lua20
2 files changed, 15 insertions, 7 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index f1c7ca1cb3..98c823ea9c 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -98,7 +98,7 @@ the VCS/git logs more valuable. The general structure of a commit message is:
```
- Prefix the commit subject with one of these [_types_](https://github.com/commitizen/conventional-commit-types/blob/master/index.json):
- - `build`, `ci`, `docs`, `feat`, `fix`, `perf`, `refactor`, `revert`, `test`, `vim-patch`, `dist`
+ - `build`, `ci`, `docs`, `feat`, `fix`, `perf`, `refactor`, `revert`, `test`, `vim-patch`
- You can **ignore this for "fixup" commits** or any commits you expect to be squashed.
- Append optional scope to _type_ such as `(lsp)`, `(treesitter)`, `(float)`, …
- _Description_ shouldn't start with a capital letter or end in a period.
diff --git a/scripts/lintcommit.lua b/scripts/lintcommit.lua
index 87a8e62503..71796a5e02 100644
--- a/scripts/lintcommit.lua
+++ b/scripts/lintcommit.lua
@@ -78,10 +78,12 @@ local function validate_commit(commit_message)
-- Check if type is correct
local type = vim.split(before_colon, "%(")[1]
- local allowed_types = {'build', 'ci', 'docs', 'feat', 'fix', 'perf', 'refactor', 'revert', 'test', 'dist', 'vim-patch'}
+ local allowed_types = {'build', 'ci', 'docs', 'feat', 'fix', 'perf', 'refactor', 'revert', 'test', 'vim-patch'}
if not vim.tbl_contains(allowed_types, type) then
return string.format(
- 'Invalid commit type "%s". Allowed types are:\n %s',
+ [[Invalid commit type "%s". Allowed types are:
+ %s.
+ If none of these seem appropriate then use "fix"]],
type,
vim.inspect(allowed_types))
end
@@ -164,13 +166,16 @@ function M.main(opt)
local invalid_msg = validate_commit(msg)
if invalid_msg then
failed = failed + 1
+
+ -- Some breathing room
+ if failed == 1 then
+ p('\n')
+ end
+
p(string.format([[
Invalid commit message: "%s"
Commit: %s
%s
- See also:
- https://github.com/neovim/neovim/blob/master/CONTRIBUTING.md#commit-messages
- https://www.conventionalcommits.org/en/v1.0.0/
]],
msg,
commit_id,
@@ -180,6 +185,10 @@ Invalid commit message: "%s"
end
if failed > 0 then
+ p([[
+See also:
+ https://github.com/neovim/neovim/blob/master/CONTRIBUTING.md#commit-messages
+]])
die() -- Exit with error.
else
p('')
@@ -198,7 +207,6 @@ function M._test()
['refactor: normal message'] = true,
['revert: normal message'] = true,
['test: normal message'] = true,
- ['dist: normal message'] = true,
['ci(window): message with scope'] = true,
['ci!: message with breaking change'] = true,
['ci(tui)!: message with scope and breaking change'] = true,